{
"openapi": "3.0.4",
"info": {
"title": "SERTICA Web API",
"description": "Online API browser for SERTICA Web API.Be aware that some endpoints are restricted by license or user rights and may not be available in your environment.Each endpoint includes a description of the required license and user rights.",
"version": "v1"
},
"servers": [
{
"url": "/api"
}
],
"paths": {
"/AccountingDimensions": {
"get": {
"tags": [
"AccountingDimensions"
],
"summary": "Gets a list of AccountingDimensions",
"operationId": "GetAccountingDimensions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"AccountingDimensions"
],
"summary": "Creates a new accountingDimension record",
"operationId": "CreateAccountingDimension",
"requestBody": {
"description": "The AccountingDimension Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensions/{dimensionNo}": {
"get": {
"tags": [
"AccountingDimensions"
],
"summary": "Gets a specific AccountingDimension",
"operationId": "GetAccountingDimension",
"parameters": [
{
"name": "dimensionNo",
"in": "path",
"description": "the dimensionNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested accountingDimension",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an accountingDimension with the supplied Dimension No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AccountingDimensions"
],
"summary": "Updates an existing AccountingDimension",
"operationId": "UpdateAccountingDimension",
"parameters": [
{
"name": "dimensionNo",
"in": "path",
"description": "The dimensionNo of the accountingDimension to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The AccountingDimension DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated AccountingDimension object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"AccountingDimensions"
],
"summary": "Deletes an accountingDimension record",
"parameters": [
{
"name": "dimensionNo",
"in": "path",
"description": "The dimensionNo of the AccountingDimension to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensions/{dimensionNo}/history": {
"get": {
"tags": [
"AccountingDimensions"
],
"summary": "Gets history for a specific AccountingDimension",
"operationId": "GetAccountingDimensionHistory",
"parameters": [
{
"name": "dimensionNo",
"in": "path",
"description": "The dimensionNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested accountingDimension",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an accountingDimension with the supplied Dimension No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensions/search": {
"post": {
"tags": [
"AccountingDimensions"
],
"summary": "Search for accountingDimensions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAccountingDimensions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensions/searchCount": {
"post": {
"tags": [
"AccountingDimensions"
],
"summary": "Returns number of hits in a search for AccountingDimensions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAccountingDimensions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensions/searchIndex/{accountingDimensionGuid}": {
"post": {
"tags": [
"AccountingDimensions"
],
"summary": "Get index of a record in a search for AccountingDimensions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAccountingDimensions",
"parameters": [
{
"name": "accountingDimensionGuid",
"in": "path",
"description": "The accountingDimension to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensions/searchInfo": {
"get": {
"tags": [
"AccountingDimensions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAccountingDimensions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AccountingDimensions/{dimensionNo}/copy": {
"get": {
"tags": [
"AccountingDimensions"
],
"summary": "Copies an existing accountingDimension to a new object",
"operationId": "CopyAccountingDimension",
"parameters": [
{
"name": "dimensionNo",
"in": "path",
"description": "The DimensionNo of the accountingDimension to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new AccountingDimension object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimension"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensions/{dimensionNo}/values": {
"get": {
"tags": [
"AccountingDimensions"
],
"summary": "Gets the list of values for a AccountingDimension",
"operationId": "GetAccountingDimensionValues",
"parameters": [
{
"name": "dimensionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensions/{dimensionNo}/derivedvalues": {
"get": {
"tags": [
"AccountingDimensions"
],
"summary": "Gets the list of derived values for a AccountingDimension",
"operationId": "GetAccountingDimensionDerivedValues",
"parameters": [
{
"name": "dimensionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionDerivedValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionDerivedValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionDerivedValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensions/{dimensionNo}/mandatoryvalues": {
"get": {
"tags": [
"AccountingDimensions"
],
"summary": "Gets the list of mandatory values for a AccountingDimension",
"operationId": "GetAccountingDimensionMandatoryValues",
"parameters": [
{
"name": "dimensionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionMandatoryValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionMandatoryValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionMandatoryValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensions/{dimensionNo}/affectors": {
"get": {
"tags": [
"AccountingDimensions"
],
"summary": "Gets the list of affectors for a AccountingDimension",
"operationId": "GetAccountingDimensionAccountingDimensionAffectors",
"parameters": [
{
"name": "dimensionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionAccountingDimensionAffector"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionAccountingDimensionAffector"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionAccountingDimensionAffector"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensionsCache/affectors": {
"get": {
"tags": [
"AccountingDimensionsCache"
],
"summary": "Gets a list of possible Affectors",
"operationId": "GetAccountingDimensionAffectors",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAffector"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAffector"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAffector"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensionsCache/affectors/search": {
"post": {
"tags": [
"AccountingDimensionsCache"
],
"summary": "Search for affectors\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAccountingDimensionAffectors",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAffector"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAffector"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAffector"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensionsCache/affectors/searchInfo": {
"get": {
"tags": [
"AccountingDimensionsCache"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAccountingDimensionAffectors",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AccountingDimensionsCache/affectors/searchCount": {
"post": {
"tags": [
"AccountingDimensionsCache"
],
"summary": "Endpoint for getting searchCount on affectors",
"operationId": "SearchCountAccountingDimensionAffectors",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensionsCache/affectors/{affectorGuid}/values": {
"get": {
"tags": [
"AccountingDimensionsCache"
],
"summary": "Get list of values for an affector with a search criteria",
"operationId": "GetAffectorValues",
"parameters": [
{
"name": "affectorGuid",
"in": "path",
"description": "The affector guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionValue"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionValue"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionValue"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensionsCache/affectors/{affectorGuid}/values/search": {
"post": {
"tags": [
"AccountingDimensionsCache"
],
"summary": "Get list of values for an affector with a search criteria",
"operationId": "SearchAffectorValues",
"parameters": [
{
"name": "affectorGuid",
"in": "path",
"description": "The affector guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search criteria",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AccountingDimensionsCache/availableValues/{objectType}": {
"post": {
"tags": [
"AccountingDimensionsCache"
],
"operationId": "GetAvailableValues",
"parameters": [
{
"name": "objectType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionObjectType"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionInfo"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionInfo"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountingDimension | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Accounts": {
"get": {
"tags": [
"Accounts"
],
"summary": "Gets a list of Accounts",
"operationId": "GetAccounts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Accounts"
],
"summary": "Creates a new account record",
"operationId": "CreateAccount",
"requestBody": {
"description": "The Account Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Account_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Accounts/{accountNo}": {
"get": {
"tags": [
"Accounts"
],
"summary": "Gets a specific Account",
"operationId": "GetAccount",
"parameters": [
{
"name": "accountNo",
"in": "path",
"description": "The AccountNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested account",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an account with the supplied Account No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Accounts"
],
"summary": "Updates an existing Account",
"operationId": "UpdateAccount",
"parameters": [
{
"name": "accountNo",
"in": "path",
"description": "The AccountNo of the account to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Account DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Account object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Account_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Accounts"
],
"summary": "Deletes a account record",
"parameters": [
{
"name": "accountNo",
"in": "path",
"description": "The AccountNo of the Account to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Account_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Accounts/{accountNo}/history": {
"get": {
"tags": [
"Accounts"
],
"summary": "Gets history for a specific Account",
"operationId": "GetAccountHistory",
"parameters": [
{
"name": "accountNo",
"in": "path",
"description": "The AccountNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested account",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an account with the supplied Account No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Account_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Accounts/search": {
"post": {
"tags": [
"Accounts"
],
"summary": "Search for Accounts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAccounts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Accounts/searchIndex/{accountGuid}": {
"post": {
"tags": [
"Accounts"
],
"summary": "Get index of a record in a search for account\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAccounts",
"parameters": [
{
"name": "accountGuid",
"in": "path",
"description": "The account to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Accounts/searchCount": {
"post": {
"tags": [
"Accounts"
],
"summary": "Returns number of hits in a search for Accounts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAccounts",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Accounts/searchInfo": {
"get": {
"tags": [
"Accounts"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAccounts",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Accounts/{accountNo}/copy": {
"get": {
"tags": [
"Accounts"
],
"summary": "Copies an existing account to a new object",
"operationId": "CopyAccount",
"parameters": [
{
"name": "accountNo",
"in": "path",
"description": "The AccountNo of the account to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Account object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.Account"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Account_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ActivityGroups": {
"get": {
"tags": [
"ActivityGroups"
],
"summary": "Gets a list of ActivityGroups",
"operationId": "GetActivityGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ActivityGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ActivityGroups"
],
"summary": "Creates a new activityGroup record",
"operationId": "CreateActivityGroup",
"requestBody": {
"description": "The activityGroups Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ActivityGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ActivityGroups/{activityGroupNo}": {
"get": {
"tags": [
"ActivityGroups"
],
"summary": "Gets a specific ActivityGroup",
"operationId": "GetActivityGroup",
"parameters": [
{
"name": "activityGroupNo",
"in": "path",
"description": "The ActivityGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested activityGroup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an activityGroup with the supplied ActivityGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ActivityGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ActivityGroups"
],
"summary": "Updates an existing activityGroup",
"operationId": "UpdateActivityGroup",
"parameters": [
{
"name": "activityGroupNo",
"in": "path",
"description": "The activityGroupNo of the activityGroup to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The activityGroup DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated activityGroup object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ActivityGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ActivityGroups"
],
"summary": "Deletes a activityGroup record",
"parameters": [
{
"name": "activityGroupNo",
"in": "path",
"description": "The activityGroupNo of the activityGroup to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ActivityGroup_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ActivityGroups/{activityGroupNo}/history": {
"get": {
"tags": [
"ActivityGroups"
],
"summary": "Gets history for a specific ActivityGroup",
"operationId": "GetActivityGroupHistory",
"parameters": [
{
"name": "activityGroupNo",
"in": "path",
"description": "The ActivityGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested activityGroup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an activityGroup with the supplied ActivityGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ActivityGroup_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ActivityGroups/search": {
"post": {
"tags": [
"ActivityGroups"
],
"summary": "Search for ActivityGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchActivityGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ActivityGroup | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ActivityGroups/searchIndex/{activityGroupGuid}": {
"post": {
"tags": [
"ActivityGroups"
],
"summary": "Get index of a record in a search for activityGroup\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexActivityGroups",
"parameters": [
{
"name": "activityGroupGuid",
"in": "path",
"description": "The activityGroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ActivityGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ActivityGroups/searchCount": {
"post": {
"tags": [
"ActivityGroups"
],
"summary": "Returns number of hits in a search for ActivityGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountActivityGroups",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ActivityGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ActivityGroups/searchInfo": {
"get": {
"tags": [
"ActivityGroups"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoActivityGroups",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ActivityGroups/{activityGroupNo}/copy": {
"get": {
"tags": [
"ActivityGroups"
],
"summary": "Copies an existing activityGroup to a new object",
"operationId": "CopyActivityGroup",
"parameters": [
{
"name": "activityGroupNo",
"in": "path",
"description": "The activityGroupNo of the activityGroup to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new activityGroup object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ActivityGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ActivityGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressCategories": {
"get": {
"tags": [
"AddressCategories"
],
"summary": "Gets a list of Address Categories",
"operationId": "AddressCategories",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressCategory | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"AddressCategories"
],
"summary": "Creates a new address category record",
"operationId": "CreateAddressCategory",
"requestBody": {
"description": "The AddressCategory Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressCategory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressCategories/{addressCategoryNo}": {
"get": {
"tags": [
"AddressCategories"
],
"summary": "Gets a specific Address Category by its AddressCategoryNo",
"operationId": "GetAddressCategory",
"parameters": [
{
"name": "addressCategoryNo",
"in": "path",
"description": "The AddressCategoryNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested address category",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an address category with the supplied AddressCategoryNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressCategory | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AddressCategories"
],
"summary": "Updates an existing AddressCategory",
"operationId": "UpdateAddressCategory",
"parameters": [
{
"name": "addressCategoryNo",
"in": "path",
"description": "The AddressCategoryNo of the address category to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The AddressCategory DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated AddressCategory object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressCategory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"AddressCategories"
],
"summary": "Deletes a address category record",
"parameters": [
{
"name": "addressCategoryNo",
"in": "path",
"description": "The AddressCategoryNo of the address category to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressCategory_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressCategories/{addressCategoryNo}/history": {
"get": {
"tags": [
"AddressCategories"
],
"summary": "Gets history for a specific Address Category",
"operationId": "GetAddressCategoryHistory",
"parameters": [
{
"name": "addressCategoryNo",
"in": "path",
"description": "The AddressCategoryNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested address category",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an address category with the supplied AddressCategoryNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressCategory_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressCategories/search": {
"post": {
"tags": [
"AddressCategories"
],
"summary": "Search for Address Categorys\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAddressCategories",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressCategory | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressCategories/searchIndex/{addressCategoryGuid}": {
"post": {
"tags": [
"AddressCategories"
],
"summary": "Get index of a record in a search for address category\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAddressCategories",
"parameters": [
{
"name": "addressCategoryGuid",
"in": "path",
"description": "The address category to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressCategory | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressCategories/searchCount": {
"post": {
"tags": [
"AddressCategories"
],
"summary": "Returns number of hits in a search for Address Categorys\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAddressCategories",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressCategory | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressCategories/searchInfo": {
"get": {
"tags": [
"AddressCategories"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAddressCategories",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AddressCategories/{addressCategoryNo}/copy": {
"get": {
"tags": [
"AddressCategories"
],
"summary": "Copies an existing address category to a new object",
"operationId": "CopyAddressCategory",
"parameters": [
{
"name": "addressCategoryNo",
"in": "path",
"description": "The AddressCategoryNo of the address category to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new AddressCategory object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressCategory"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressCategory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressClassifications": {
"get": {
"tags": [
"AddressClassifications"
],
"summary": "Gets a list of Address classifications",
"operationId": "GetAddressClassifications",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressClassification | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"AddressClassifications"
],
"summary": "Creates a new address classification record",
"operationId": "CreateAddressClassification",
"requestBody": {
"description": "The AddressClassification Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressClassification_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressClassifications/{classificationNo}": {
"get": {
"tags": [
"AddressClassifications"
],
"summary": "Gets a specific Address classification by its ClassificationNo",
"operationId": "GetAddressClassification",
"parameters": [
{
"name": "classificationNo",
"in": "path",
"description": "The ClassificationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested address classification",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an address classification with the supplied ClassificationNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressClassification | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AddressClassifications"
],
"summary": "Updates an existing AddressClassification",
"operationId": "UpdateAddressClassification",
"parameters": [
{
"name": "classificationNo",
"in": "path",
"description": "The ClassificationNo of the address classification to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The AddressClassification DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated AddressClassification object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressClassification_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"AddressClassifications"
],
"summary": "Deletes a address classification record",
"parameters": [
{
"name": "classificationNo",
"in": "path",
"description": "The ClassificationNo of the address classification to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressClassification_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressClassifications/{classificationNo}/history": {
"get": {
"tags": [
"AddressClassifications"
],
"summary": "Gets history for a specific Address Classification",
"operationId": "GetAddressClassificationHistory",
"parameters": [
{
"name": "classificationNo",
"in": "path",
"description": "The ClassificationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested address classification",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an address classification with the supplied ClassificationNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressClassification_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressClassifications/search": {
"post": {
"tags": [
"AddressClassifications"
],
"summary": "Search for Address classifications\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAddressClassifications",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressClassification | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressClassifications/searchIndex/{addressClassificationGuid}": {
"post": {
"tags": [
"AddressClassifications"
],
"summary": "Get index of a record in a search for address classification\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAddressClassifications",
"parameters": [
{
"name": "addressClassificationGuid",
"in": "path",
"description": "The address classification to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressClassification | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressClassifications/searchCount": {
"post": {
"tags": [
"AddressClassifications"
],
"summary": "Returns number of hits in a search for Address classifications\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAddressClassifications",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressClassification | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AddressClassifications/searchInfo": {
"get": {
"tags": [
"AddressClassifications"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAddressClassifications",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AddressClassifications/{classificationNo}/copy": {
"get": {
"tags": [
"AddressClassifications"
],
"summary": "Copies an existing address classification to a new object",
"operationId": "CopyAddressClassification",
"parameters": [
{
"name": "classificationNo",
"in": "path",
"description": "The ClassificationNo of the address classification to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new AddressClassification object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.AddressClassification"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AddressClassification_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses": {
"get": {
"tags": [
"Addresses"
],
"summary": "Gets a list of Addresss",
"operationId": "GetAddresses",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Addresses"
],
"summary": "Creates a new address record",
"operationId": "CreateAddress",
"requestBody": {
"description": "The Address Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}": {
"get": {
"tags": [
"Addresses"
],
"summary": "Gets a specific Address",
"operationId": "GetAddress",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The AddressNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested address",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an address with the supplied Address No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Addresses"
],
"summary": "Updates an existing Address",
"operationId": "UpdateAddress",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The AddressNo of the address to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Address DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Address object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Addresses"
],
"summary": "Deletes a address record",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The AddressNo of the Address to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/history": {
"get": {
"tags": [
"Addresses"
],
"summary": "Gets history for a specific Address",
"operationId": "GetAddressHistory",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The AddressNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested address",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an address with the supplied Address No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/search": {
"post": {
"tags": [
"Addresses"
],
"summary": "Search for Addresss\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAddresses",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/searchCount": {
"post": {
"tags": [
"Addresses"
],
"summary": "Returns number of hits in a search for Addresss\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAddresss",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/searchIndex/{addressGuid}": {
"post": {
"tags": [
"Addresses"
],
"summary": "Get index of a record in a search for address\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAddresses",
"parameters": [
{
"name": "addressGuid",
"in": "path",
"description": "The address to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/searchInfo": {
"get": {
"tags": [
"Addresses"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAddresss",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Addresses/{addressNo}/Contacts": {
"get": {
"tags": [
"Addresses"
],
"summary": "Returns a list of Contacts used for the Address",
"operationId": "GetAddressContacts",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The AddressNo to fetch contacts for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the contacts for the address",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressContact"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressContact"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressContact"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/AddressEvaluations": {
"get": {
"tags": [
"Addresses"
],
"summary": "Returns a list of Address Evaluations belonging to the Address",
"operationId": "GetAddressEvaluations",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The AddressNo to fetch address evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the address evaluations belonging to the address",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/addressEvaluations/{groupId}": {
"get": {
"tags": [
"Addresses"
],
"summary": "Returns a list of Address Evaluations belonging to the given groupId",
"operationId": "GetAddressEvaluationsByGroupId",
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "The groupId to fetch address evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the address evaluations belonging to the groupId",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/addressEvaluations": {
"post": {
"tags": [
"Addresses"
],
"summary": "Creates new address evaluation records",
"operationId": "CreateAddressEvaluations",
"requestBody": {
"description": "The list of Address evaluation Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Addresses"
],
"summary": "Updates existing address evaluation records",
"operationId": "UpdateAddressEvaluations",
"requestBody": {
"description": "The list of Address evaluation Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/searchAddressEvaluations": {
"post": {
"tags": [
"Addresses"
],
"summary": "Search for AddresssEvaluations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAddressEvaluations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/Documents": {
"get": {
"tags": [
"Addresses"
],
"summary": "Returns a list of Documents on the Address",
"operationId": "GetAddressDocumentLinks",
"parameters": [
{
"name": "addressNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/copy": {
"get": {
"tags": [
"Addresses"
],
"summary": "Copies an existing Address to a new object",
"operationId": "CopyAddress",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The AddressNo of the address to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Address object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.Address"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/responses": {
"get": {
"tags": [
"Addresses"
],
"summary": "Gets a list of Address Responses",
"operationId": "GetAddressResponses",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The Address No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/responses/count": {
"get": {
"tags": [
"Addresses"
],
"summary": "Returns number of AddressResponses for AddressNo",
"operationId": "CountAddressResponses",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The AddressNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{AddressNo}/addResponse": {
"post": {
"tags": [
"Addresses"
],
"summary": "Add response",
"operationId": "AddAddressResponse",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The AddressNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The AddressResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/units": {
"get": {
"tags": [
"Addresses"
],
"summary": "Fetches all Unit Filters attached to the Address",
"operationId": "GetAddressUnits",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The addressNo to fetch addressUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the Address",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/itemtypes": {
"get": {
"tags": [
"Addresses"
],
"summary": "Fetches all ItemTypes attached to the Address",
"operationId": "GetAddressItemTypes",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The addressNo to fetch addressItemTypes for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the ItemTypes for the Address",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressItemType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressItemType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressItemType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ItemTypesOnHeader |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/addressaddresscategories": {
"get": {
"tags": [
"Addresses"
],
"summary": "Fetches all AddressAddressCategories attached to the Address",
"operationId": "GetAddressAddressCategories",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The addressNo to fetch AddressAddressCategories for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the AddressAddressCategories for the Address",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressAddressCategory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressAddressCategory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressAddressCategory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/deliverycosts": {
"get": {
"tags": [
"Addresses"
],
"summary": "Fetches all DeliveryCosts attached to the Address",
"operationId": "GetAddressDeliveryCosts",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The addressNo to fetch addressDeliveryCostss for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the DeliveryCostss for the Address",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressDeliveryCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressDeliveryCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressDeliveryCost"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/alternatepayers": {
"get": {
"tags": [
"Addresses"
],
"summary": "Fetches all AlternatePayer attached to the Address",
"operationId": "GetAddressAlternatePayers",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The addressNo to fetch AddressAlternatePayers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the AlternatePayers for the Address",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressAlternatePayer"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressAlternatePayer"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressAlternatePayer"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/punchouts": {
"get": {
"tags": [
"Addresses"
],
"summary": "Fetches all PunchOut References attached to the Address",
"operationId": "GetAddressPunchOuts",
"parameters": [
{
"name": "addressNo",
"in": "path",
"description": "The addressNo to fetch AddressPunchOut for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the PunchOuts for the Address",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressPunchOut"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressPunchOut"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressPunchOut"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| PunchoutIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/contacts/{guid}/generateConnectPassword": {
"post": {
"tags": [
"Addresses"
],
"summary": "Generate new password for Connect",
"operationId": "GenerateAddressContactConnectPassword",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "Address Contact guid",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "addressNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressContact"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressContact"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressContact"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Addresses/{addressNo}/contacts/{guid}/unlockAccount": {
"post": {
"tags": [
"Addresses"
],
"summary": "Unlock AddressContact account in connect",
"operationId": "UnlockAddressContactAccount",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "Address Contact guid",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "addressNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressContact"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressContact"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressContact"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AiClient/ask-question": {
"put": {
"tags": [
"AiClient"
],
"summary": "Asks a question to the AI through the AI Service.",
"operationId": "AIAskQuestion",
"requestBody": {
"description": "Question and relevant context for asking AI",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AiClient.AiClientAskModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AiClient.AiClientAskModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AiClient.AiClientAskModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AiClient.AiClientAskModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AiClient.AiClientAskResponseModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AiClient.AiClientAskResponseModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AiClient.AiClientAskResponseModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_ChangeAvailableForAI | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get All Menu Items",
"operationId": "GetAllMenuItems",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Analytics"
],
"summary": "Save a Report",
"operationId": "CreateReport",
"requestBody": {
"description": "Report Object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/{reportNo}": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get Report by ReportNo",
"operationId": "GetAnalyticsReport",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "ReportNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Analytics"
],
"summary": "Update a Report",
"operationId": "UpdateReport",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Report Object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Analytics"
],
"summary": "Delete a Report",
"operationId": "DeleteReport",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "Report No.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/{reportNo}/copy": {
"get": {
"tags": [
"Analytics"
],
"operationId": "CopyReport",
"parameters": [
{
"name": "reportNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/{reportNo}/outputFields": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get output fields for a report",
"operationId": "GetReportOutputFields",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportOutputField"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportOutputField"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportOutputField"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/{reportNo}/filterFields": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get filter fields for a report",
"operationId": "GetReportFilterFields",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterField"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterField"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterField"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/{reportNo}/excel": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get Excel Doc by ReportNo",
"operationId": "GetReportExcelByNo",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "ReportNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/excel": {
"post": {
"tags": [
"Analytics"
],
"summary": "Get Excel Doc from updated Report",
"operationId": "GetReportExcel",
"requestBody": {
"description": "Report Object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/reportSetting/{settingsKey}/excel": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get Excel File with layout from Report stored in usersettings",
"operationId": "GetReportExcelByUserSetting",
"parameters": [
{
"name": "settingsKey",
"in": "path",
"description": "The user settingskey that contains the report object to get as Excel report",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/{reportNo}/dataset": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get Dataset by ReportNo",
"operationId": "GetReportDatasetByNo",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "ReportNo",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitList",
"in": "query",
"description": "Filter List of units separated by '|'",
"schema": {
"type": "string"
}
},
{
"name": "dateFilterField",
"in": "query",
"description": "Output field name or guid to filter by fromDate and toDate",
"schema": {
"type": "string"
}
},
{
"name": "fromDate",
"in": "query",
"description": "Filter from date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "toDate",
"in": "query",
"description": "Filter to date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "objectIdFilterField",
"in": "query",
"description": "Output field name or guid to filter by objectId",
"schema": {
"type": "string"
}
},
{
"name": "objectId",
"in": "query",
"description": "Filter by objectId",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/dataset": {
"post": {
"tags": [
"Analytics"
],
"summary": "Get Dataset from updated Report",
"operationId": "GetReportDataset",
"parameters": [
{
"name": "top",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Report Object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/reportSetting/{settingsKey}/dataset": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get Dataset with layout from Report stored in usersettings",
"operationId": "GetReportDatasetByUserSetting",
"parameters": [
{
"name": "settingsKey",
"in": "path",
"description": "The user settingskey that contains the report object to get as dataset",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/{templateFieldName}/distinctList/{filtered}": {
"post": {
"tags": [
"Analytics"
],
"summary": "Get DistinctList from ReportFilterField",
"operationId": "GetDistinctList",
"parameters": [
{
"name": "templateFieldName",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filtered",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/templates": {
"get": {
"tags": [
"Analytics"
],
"summary": "Gets a list of AnalyticsTemplates",
"operationId": "GetAnalyticsTemplateStructure",
"parameters": [
{
"name": "includeEmptyMenus",
"in": "query",
"description": "",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/templates/{templateNo}": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get Template by TemplateNo",
"operationId": "GetTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "TemplateNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/templates/{templateNo}/templatefields": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get Template with TemplateFields by TemplateNo",
"operationId": "GetTemplatesFields",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "TemplateNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/customTemplates/{templateNo}": {
"get": {
"tags": [
"Analytics"
],
"summary": "Gets a specific AnalyticsCustomTemplate",
"operationId": "GetCustomTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "TemplateNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested analyticsCustomTemplate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an analyticsCustomTemplate with the supplied AnalyticsCustomTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/customTemplates/{templateNo}/templatefields": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get CustomTemplate with TemplateFields by TemplateNo",
"operationId": "GetCustomTemplatesFields",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "CustomTemplateNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/datawarehousetemplates/{templateNo}": {
"get": {
"tags": [
"Analytics"
],
"summary": "Gets a specific DataWarehouseAnalyticsTemplate",
"operationId": "GetDataWarehouseTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "TemplateNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested DataWarehouseAnalyticsTemplate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an DataWarehouseAnalyticsTemplate with the supplied DataWarehouseAnalyticsTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Analytics/datawarehousetemplates/{templateNo}/templatefields": {
"get": {
"tags": [
"Analytics"
],
"summary": "Get DataWarehouseAnalyticsTemplate with TemplateFields by TemplateNo",
"operationId": "GetDataWarehouseTemplateFields",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "DataWarehouseAnalyticsTemplateNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomMenus": {
"get": {
"tags": [
"AnalyticsCustomMenus"
],
"summary": "Get the user menu tree structure",
"operationId": "GetCustomMenus",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"AnalyticsCustomMenus"
],
"operationId": "CreateCustomMenu",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomMenus/{guid}": {
"get": {
"tags": [
"AnalyticsCustomMenus"
],
"operationId": "GetCustomMenu",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"AnalyticsCustomMenus"
],
"operationId": "DeleteCustomMenu",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomMenus/{menuGuid}": {
"put": {
"tags": [
"AnalyticsCustomMenus"
],
"operationId": "UpdateCustomMenu",
"parameters": [
{
"name": "menuGuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates": {
"get": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Gets a list of AnalyticsCustomTemplates",
"operationId": "GetAnalyticsCustomTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Creates a new Custom Analytics Template record.",
"operationId": "CreateAnalyticsCustomTemplate",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns a new Custom Analytics Template record",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
},
"400": {
"description": "Returns a new Validation Result",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates/{templateNo}": {
"get": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Get AnalyticsCustomTemplate by AnalyticsCustomTemplateNo",
"operationId": "GetAnalyticsCustomTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AnalyticsCustomTemplates"
],
"operationId": "UpdateAnalyticsCustomTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Delete a AnalyticsCustomTemplate",
"operationId": "DeleteAnalyticsCustomTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "AnalyticsCustomTemplate No.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates/{templateNo}/history": {
"get": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Gets history for a specific AnalyticsCustomTemplate",
"operationId": "GetAnalyticsCustomTemplateHistory",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "The TemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested analyticsCustomTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an analyticsCustomTemplate with the supplied AnalyticsCustomTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates/searchIndex/{analyticsCustomTemplateGuid}": {
"post": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Get index of a record in a search for analyticsCustomTemplate\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAnalyticsCustomTemplates",
"parameters": [
{
"name": "analyticsCustomTemplateGuid",
"in": "path",
"description": "The analyticsCustomTemplate to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates/search": {
"post": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Search for AnalyticsCustomTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAnalyticsCustomTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested analyticsCustomTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates/searchCount": {
"post": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Returns number of hits in a search for AnalyticsCustomTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAnalyticsCustomTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates/searchInfo": {
"get": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAnalyticsCustomTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AnalyticsCustomTemplates/{templateNo}/templateFields": {
"get": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Fetches all AnalyticsCustomTemplateFields attached to the AnalyticsCustomTemplate",
"operationId": "GetAnalyticsCustomTemplateFields",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "The Template No to fetch Fields for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Template Fields for the Template",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateField"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateField"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateField"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates/{templateNo}/scanview": {
"post": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "ScanView and update custom analytics template",
"operationId": "ScanView",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateScanViewResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateScanViewResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateScanViewResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates/{templateNo}/copy": {
"get": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Copies an existing Custom Analytics Template to a new record.",
"operationId": "CopyAnalyticsCustomTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a new Custom Analytics Template record",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
},
"400": {
"description": "Returns a new Validation Result",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates/{templateNo}/resources": {
"get": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Fetches all Resources attached to the AnalyticsCustomTemplate",
"operationId": "GetAnalyticsCustomTemplateResources",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateResource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsCustomTemplates/{templateNo}/roles": {
"get": {
"tags": [
"AnalyticsCustomTemplates"
],
"summary": "Fetches all Roles attached to the AnalyticsCustomTemplate",
"operationId": "GetAnalyticsCustomTemplateRoles",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateRole"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateRole"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateRole"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsCustomTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates": {
"get": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Gets a list of AnalyticsExcelTemplates",
"operationId": "GetAnalyticsExcelTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Creates a new document record",
"operationId": "CreateAnalyticsExcelTemplate",
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_Update | Update |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/{documentNo}": {
"get": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Gets a specific AnalyticsExcelTemplate",
"operationId": "GetAnalyticsExcelTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Updates an existing Document",
"operationId": "UpdateAnalyticsExcelTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_Update | Update |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/searchIndex/{documentGuid}": {
"post": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Get index of a record in a search for AnalyticsExcelTemplate\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAnalyticsExcelTemplates",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/{documentNo}/history": {
"get": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Gets history for a specific AnalyticsExcelTemplate",
"operationId": "GetAnalyticsExcelTemplateHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/search": {
"post": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAnalyticsExcelTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/searchCount": {
"post": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAnalyticsExcelTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/searchInfo": {
"get": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAnalyticsExcelTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AnalyticsExcelTemplates/{documentNo}/pdf": {
"get": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "",
"operationId": "GetAnalyticsExcelTemplatePdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/{documentNo}/file": {
"get": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "",
"operationId": "GetAnalyticsExcelTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"AnalyticsExcelTemplates"
],
"operationId": "AddAnalyticsExcelTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dataSheet",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "IsValid",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "Errors",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ErrorReason"
}
}
},
{
"name": "BrokenRules",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BrokenRule"
}
}
},
{
"name": "SubResults",
"in": "query",
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_Update | Update |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Get document pdf from guid",
"operationId": "GetAnalyticsExcelTemplatePdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Get document file from guid",
"operationId": "GetAnalyticsExcelTemplateFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/{documentNo}/checkout": {
"put": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutAnalyticsExcelTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_Update | Update |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/{documentNo}/checkin": {
"post": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "",
"operationId": "CheckinAnalyticsExcelTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "dataSheet",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "IsValid",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "Errors",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ErrorReason"
}
}
},
{
"name": "BrokenRules",
"in": "query",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BrokenRule"
}
}
},
{
"name": "SubResults",
"in": "query",
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_Update | Update |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/{documentNo}/copy": {
"get": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyAnalyticsExcelTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsExcelTemplates/{documentNo}/usage": {
"get": {
"tags": [
"AnalyticsExcelTemplates"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetAnalyticsExcelTemplatesUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsReports": {
"get": {
"tags": [
"AnalyticsReports"
],
"summary": "Gets a list of AnalyticsReports",
"operationId": "GetAnalyticsReports",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsReports/{reportNo}": {
"get": {
"tags": [
"AnalyticsReports"
],
"summary": "Get Report by ReportNo",
"operationId": "GetReport",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AnalyticsReports"
],
"operationId": "UpdateAnalyticsReport",
"parameters": [
{
"name": "reportNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"AnalyticsReports"
],
"summary": "Delete a Report",
"operationId": "DeleteAnalyticsReport",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "Report No.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_Delete | Delete |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsReports/{analyticsReportNo}/history": {
"get": {
"tags": [
"AnalyticsReports"
],
"summary": "Gets history for a specific AnalyticsReport",
"operationId": "GetAnalyticsReportHistory",
"parameters": [
{
"name": "analyticsReportNo",
"in": "path",
"description": "The AnalyticsReportNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested analyticsReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an analyticsReport with the supplied AnalyticsReport No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsReports/searchIndex/{analyticsReportGuid}": {
"post": {
"tags": [
"AnalyticsReports"
],
"summary": "Get index of a record in a search for analyticsReport\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAnalyticsReports",
"parameters": [
{
"name": "analyticsReportGuid",
"in": "path",
"description": "The analyticsReport to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsReports/search": {
"post": {
"tags": [
"AnalyticsReports"
],
"summary": "Search for AnalyticsReports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAnalyticsReports",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested analyticsReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsReports/searchCount": {
"post": {
"tags": [
"AnalyticsReports"
],
"summary": "Returns number of hits in a search for AnalyticsReports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAnalyticsReports",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsReports/searchInfo": {
"get": {
"tags": [
"AnalyticsReports"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAnalyticsReports",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AnalyticsReports/{reportNo}/resources": {
"get": {
"tags": [
"AnalyticsReports"
],
"summary": "Fetches all resources attached to the Report",
"operationId": "GetAnalyticsReportResources",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "The reportNo to fetch resources for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the resources for the AnalyticsReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportResource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsReports/{reportNo}/subReports": {
"get": {
"tags": [
"AnalyticsReports"
],
"summary": "Fetches all sub reports attached to the Report",
"operationId": "GetAnalyticsReportSubReports",
"parameters": [
{
"name": "reportNo",
"in": "path",
"description": "The reportNo to fetch resources for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the sub reports for the AnalyticsReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportSubReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportSubReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportSubReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsReports/{reportNo}/subscriptions": {
"get": {
"tags": [
"AnalyticsReports"
],
"operationId": "GetAnalyticsReportSubscriptions",
"parameters": [
{
"name": "reportNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsResources": {
"get": {
"tags": [
"AnalyticsResources"
],
"summary": "Gets a list of Analytics Resources",
"operationId": "GetAnalyticsResources",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsResources/{resourceNo}": {
"get": {
"tags": [
"AnalyticsResources"
],
"summary": "Gets a specific Analytics Resource",
"operationId": "GetAnalyticsResource",
"parameters": [
{
"name": "resourceNo",
"in": "path",
"description": "The ResourceNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested resource",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an resource with the supplied Resource No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsResources/search": {
"post": {
"tags": [
"AnalyticsResources"
],
"summary": "Search for Analytics Resources\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAnalyticsResources",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested resource",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsResources/searchIndex/{resourceGuid}": {
"post": {
"tags": [
"AnalyticsResources"
],
"summary": "Get index of a record in a search for Analytics resources\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAnalyticsResources",
"parameters": [
{
"name": "resourceGuid",
"in": "path",
"description": "The resource to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsResources/searchCount": {
"post": {
"tags": [
"AnalyticsResources"
],
"summary": "Returns number of hits in a search for Analytics Resources\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAnalyticsResources",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsResources/searchInfo": {
"get": {
"tags": [
"AnalyticsResources"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAnalyticsResources",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AnalyticsSubscriptions": {
"get": {
"tags": [
"AnalyticsSubscriptions"
],
"summary": "Gets a list of AnalyticsSubscriptions",
"operationId": "GetAnalyticsSubscriptions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsSubscriptions/{guid}": {
"get": {
"tags": [
"AnalyticsSubscriptions"
],
"summary": "Gets a specific AnalyticsSubscription including its recipients",
"operationId": "GetAnalyticsSubscription",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The Guid of the subscription to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested AnalyticsSubscription",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an AnalyticsSubscription with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsSubscriptions/search": {
"post": {
"tags": [
"AnalyticsSubscriptions"
],
"summary": "Search for AnalyticsSubscriptions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAnalyticsSubscriptions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsSubscriptions/searchCount": {
"post": {
"tags": [
"AnalyticsSubscriptions"
],
"summary": "Returns number of hits in a search for AnalyticsSubscriptions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAnalyticsSubscriptions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsSubscriptions/searchIndex/{analyticsSubscriptionGuid}": {
"post": {
"tags": [
"AnalyticsSubscriptions"
],
"summary": "Get index of a record in a search for AnalyticsSubscriptions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAnalyticsSubscriptions",
"parameters": [
{
"name": "analyticsSubscriptionGuid",
"in": "path",
"description": "The subscription to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsReport | View |
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsSubscriptions/searchInfo": {
"get": {
"tags": [
"AnalyticsSubscriptions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAnalyticsSubscriptions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AnalyticsTemplateUserRights/templates": {
"get": {
"tags": [
"AnalyticsTemplateUserRights"
],
"operationId": "GetAnalyticsTemplateUserRightsTemplateStructure",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsTemplateAssignRights | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsTemplateUserRights/systemTemplate/{templateNo}": {
"get": {
"tags": [
"AnalyticsTemplateUserRights"
],
"summary": "Get Template by TemplateNo",
"operationId": "TemplateUserRightsGetAnalyticsTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "TemplateNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsTemplateAssignRights | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AnalyticsTemplateUserRights"
],
"summary": "Updates an AnalyticsTemplate with Availability, Resource List and Role List",
"operationId": "UpdateAnalyticsTemplateUserRights",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsTemplateAssignRights_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsTemplateUserRights/customtemplate/{templateNo}": {
"get": {
"tags": [
"AnalyticsTemplateUserRights"
],
"summary": "Gets a specific AnalyticsCustomTemplate",
"operationId": "TemplateUserRightsGetAnalyticsCustomTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "TemplateNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested analyticsCustomTemplate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an analyticsCustomTemplate with the supplied AnalyticsCustomTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsTemplateAssignRights | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AnalyticsTemplateUserRights"
],
"operationId": "UpdateAnalyticsCustomTemplateUserRights",
"parameters": [
{
"name": "templateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsTemplateAssignRights_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsTemplateUserRights/dataWarehouseTemplate/{templateNo}": {
"get": {
"tags": [
"AnalyticsTemplateUserRights"
],
"operationId": "TemplateUserRightsGetDataWarehouseAnalyticsTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsTemplateAssignRights | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AnalyticsTemplateUserRights"
],
"operationId": "UpdateDataWarehouseAnalyticsTemplateUserRights",
"parameters": [
{
"name": "templateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsTemplateAssignRights_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsUserMenus": {
"get": {
"tags": [
"AnalyticsUserMenus"
],
"summary": "Get the user menu tree structure",
"operationId": "GetUserMenus",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"AnalyticsUserMenus"
],
"operationId": "CreateUserMenu",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AnalyticsUserMenus/{menuNo}": {
"get": {
"tags": [
"AnalyticsUserMenus"
],
"operationId": "GetUserMenu",
"parameters": [
{
"name": "menuNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AnalyticsUserMenus"
],
"operationId": "UpdateUserMenu",
"parameters": [
{
"name": "menuNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"AnalyticsUserMenus"
],
"operationId": "DeleteUserMenu",
"parameters": [
{
"name": "menuNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AnalyticsMain | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ApprovalSetups": {
"get": {
"tags": [
"ApprovalSetups"
],
"summary": "Gets a list of ApprovalSetup",
"operationId": "GetApprovalSetups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ApprovalSetups"
],
"summary": "Creates a new ApprovalSetup record",
"operationId": "CreateApprovalSetup",
"requestBody": {
"description": "The ApprovalSetup Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ApprovalSetups/{approvalSetupNo}": {
"get": {
"tags": [
"ApprovalSetups"
],
"summary": "Gets a specific ApprovalSetup",
"operationId": "GetApprovalSetup",
"parameters": [
{
"name": "approvalSetupNo",
"in": "path",
"description": "the approvalSetupNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested ApprovalSetup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ApprovalSetup with the supplied Dimension No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ApprovalSetups"
],
"summary": "Updates an existing ApprovalSetup",
"operationId": "UpdateApprovalSetup",
"parameters": [
{
"name": "approvalSetupNo",
"in": "path",
"description": "The approvalSetupNo of the approvalSetup to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ApprovalSetup DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ApprovalSetup object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ApprovalSetups"
],
"summary": "Deletes an approvalSetup record",
"parameters": [
{
"name": "approvalSetupNo",
"in": "path",
"description": "The approvalSetupNo of the ApprovalSetup to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ApprovalSetups/{approvalSetupNo}/history": {
"get": {
"tags": [
"ApprovalSetups"
],
"summary": "Gets history for a specific ApprovalSetup",
"operationId": "GetApprovalSetupHistory",
"parameters": [
{
"name": "approvalSetupNo",
"in": "path",
"description": "The approvalSetupNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested ApprovalSetup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ApprovalSetup with the supplied Approval Setup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ApprovalSetups/search": {
"post": {
"tags": [
"ApprovalSetups"
],
"summary": "Search for approvalSetups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchApprovalSetups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ApprovalSetups/searchCount": {
"post": {
"tags": [
"ApprovalSetups"
],
"summary": "Returns number of hits in a search for ApprovalSetups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountApprovalSetups",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ApprovalSetups/searchIndex/{approvalSetupGuid}": {
"post": {
"tags": [
"ApprovalSetups"
],
"summary": "Get index of a record in a search for ApprovalSetups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexApprovalSetups",
"parameters": [
{
"name": "approvalSetupGuid",
"in": "path",
"description": "The approvalSetup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ApprovalSetups/searchInfo": {
"get": {
"tags": [
"ApprovalSetups"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoApprovalSetups",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ApprovalSetups/{approvalSetupNo}/copy": {
"get": {
"tags": [
"ApprovalSetups"
],
"summary": "Copies an existing approvalSetup to a new object",
"operationId": "CopyApprovalSetup",
"parameters": [
{
"name": "approvalSetupNo",
"in": "path",
"description": "The ApprovalSetupNo of the ApprovalSetup to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ApprovalSetup object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ApprovalSetups/{approvalSetupNo}/approvers": {
"get": {
"tags": [
"ApprovalSetups"
],
"summary": "Returns a list of Approvers on the Form",
"operationId": "GetApprovalSetupApprovers",
"parameters": [
{
"name": "approvalSetupNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetupCombinedUserRole2"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetupCombinedUserRole2"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetupCombinedUserRole2"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ApprovalSetup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ApprovalWebExcludedUnits": {
"get": {
"tags": [
"ApprovalWebExcludedUnits"
],
"summary": "Gets all approval web excluded units",
"operationId": "GetApprovalWebExcludedUnits",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApprovalWebExcludedUnit.ApprovalWebExcludedUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApprovalWebExcludedUnit.ApprovalWebExcludedUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApprovalWebExcludedUnit.ApprovalWebExcludedUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ApprovalWebExcludedUnits/{unitNo}": {
"post": {
"tags": [
"ApprovalWebExcludedUnits"
],
"summary": "Excludes the unit",
"operationId": "ExcludeUnit",
"parameters": [
{
"name": "unitNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApprovalWebExcludedUnit.ApprovalWebExcludedUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApprovalWebExcludedUnit.ApprovalWebExcludedUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApprovalWebExcludedUnit.ApprovalWebExcludedUnit"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ApprovalWebExcludedUnits"
],
"summary": "Removes the unit from the excluded list",
"operationId": "DeleteUnitExclusion",
"parameters": [
{
"name": "unitNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApprovalWebExcludedUnit.ApprovalWebExcludedUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApprovalWebExcludedUnit.ApprovalWebExcludedUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApprovalWebExcludedUnit.ApprovalWebExcludedUnit"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Auth": {
"get": {
"tags": [
"Auth"
],
"summary": "Returns info on current user",
"operationId": "Get current user info",
"responses": {
"200": {
"description": "Information about current user",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LoggedInUser"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LoggedInUser"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LoggedInUser"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Auth"
],
"summary": "Generates a JWT token to be used in Authorization header in subsequent requests to API",
"operationId": "CreateJwtToken",
"parameters": [
{
"name": "lifetime",
"in": "query",
"description": "Optional token lifetime in minutes",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Login information about login, password, role and unit",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.SerticaUser"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.SerticaUser"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.SerticaUser"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.SerticaUser"
}
}
}
},
"responses": {
"200": {
"description": "Returns a token and expiration information",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.JwtToken"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.JwtToken"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.JwtToken"
}
}
}
},
"400": {
"description": "Returns a Validation Result with reasons",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Auth/integrations": {
"get": {
"tags": [
"Auth"
],
"summary": "Returns info on configured Authentication Integrations",
"operationId": "AuthIntegrations",
"responses": {
"200": {
"description": "Information about configured integrations",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.AuthenticationIntegration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.AuthenticationIntegration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.AuthenticationIntegration"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Auth/units": {
"get": {
"tags": [
"Auth"
],
"summary": "Gets a Tree of Unit/UnitGroups which the current user has access to",
"operationId": "Get List of Units current user has access to",
"responses": {
"200": {
"description": "Information about current user",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.UnitStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.UnitStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.UnitStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Auth/userRights": {
"get": {
"tags": [
"Auth"
],
"summary": "Returns current user's user rights",
"operationId": "Get list of valid user rights for the user",
"responses": {
"200": {
"description": "",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Auth/{login}/roles": {
"get": {
"tags": [
"Auth"
],
"summary": "Returns a list of roles valid for the user with supplied login",
"operationId": "Get list of roles assigned to user",
"parameters": [
{
"name": "login",
"in": "path",
"description": "The Login to fetch roles from",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "A list of Roles",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LoginRole"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LoginRole"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LoginRole"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Auth/accessToken": {
"post": {
"tags": [
"Auth"
],
"operationId": "CreateAccessToken",
"parameters": [
{
"name": "lifetime",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.AccessRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.AccessRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.AccessRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.AccessRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.JwtToken"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.JwtToken"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.JwtToken"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Auth/fileDownloadToken": {
"get": {
"tags": [
"Auth"
],
"operationId": "Get a temporary token for file download",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.JwtToken"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.JwtToken"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.JwtToken"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.UnauthorizedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.UnauthorizedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.UnauthorizedResult"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Auth/forgotPassword": {
"post": {
"tags": [
"Auth"
],
"operationId": "ForgotPassword",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ForgotPasswordInformation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ForgotPasswordInformation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ForgotPasswordInformation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ForgotPasswordInformation"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Auth/resetPassword": {
"post": {
"tags": [
"Auth"
],
"operationId": "ResetPassword",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ResetPasswordInformation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ResetPasswordInformation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ResetPasswordInformation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ResetPasswordInformation"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Auth/changePassword": {
"post": {
"tags": [
"Auth"
],
"operationId": "ChangePassword",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ChangePasswordInformation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ChangePasswordInformation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ChangePasswordInformation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ChangePasswordInformation"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Auth/officeSiteUrl": {
"get": {
"tags": [
"Auth"
],
"summary": "Gets the route URL to the office site",
"operationId": "GetOfficeSetUrl",
"responses": {
"200": {
"description": "Information about current user",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Auth/resetPin": {
"post": {
"tags": [
"Auth"
],
"operationId": "ResetPin",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ResetPinInformation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ResetPinInformation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ResetPinInformation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ResetPinInformation"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Auth/totp/setup": {
"post": {
"tags": [
"Auth"
],
"summary": "Initiates TOTP setup for the user by generating a secret and QR code",
"operationId": "SetupTotp",
"responses": {
"200": {
"description": "Returns information for authenticator app setup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.TotpSetup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.TotpSetup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.TotpSetup"
}
}
}
},
"400": {
"description": "Returns a Validation Result with reason",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Auth/totp/confirm": {
"post": {
"tags": [
"Auth"
],
"summary": "Confirms TOTP is setup by verifying a code from the user's authenticator app",
"operationId": "ConfirmTotpSetup",
"requestBody": {
"description": "Code from authenticator app",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "TOTP setup confirmed and enabled successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.TotpSetup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.TotpSetup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.TotpSetup"
}
}
}
},
"400": {
"description": "Returns a Validation Result with reason",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Auth/totp/recoverycodes/generate": {
"post": {
"tags": [
"Auth"
],
"summary": "Generates recovery codes for the user's TOTP authentication",
"operationId": "GenerateRecoveryCodes",
"responses": {
"200": {
"description": "Returns a list of recovery codes",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"400": {
"description": "Returns a Validation Result with reason",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Auth/totp/disable": {
"delete": {
"tags": [
"Auth"
],
"summary": "Disables TOTP authentication for the user",
"operationId": "DisableTotp",
"requestBody": {
"description": "CCode from authenticator app",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "TOTP authentication disabled",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.TotpSetup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.TotpSetup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.TotpSetup"
}
}
}
},
"400": {
"description": "Returns a Validation Result with reason",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableGridLayouts": {
"get": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Gets a list of SavedGridLayouts available in the job list for the current user",
"operationId": "GetAvailableGridLayouts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| LogbookEvent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Creates a new savedgridlayout record",
"operationId": "CreateAvailableGridLayout",
"requestBody": {
"description": "The SavedGridLayout Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| LogbookEvent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableGridLayouts/{guid}": {
"get": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Gets a specific SavedGridLayout",
"operationId": "GetAvailableGridLayout",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested savedgridlayout",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an savedgridlayout with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| LogbookEvent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Updates an existing SavedGridLayout",
"operationId": "UpdateAvailableGridLayout",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid of the savedgridlayout to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The SavedGridLayout DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated SavedGridLayout object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| LogbookEvent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Deletes a savedgridlayout record",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The Guid of the SavedGridLayout to delete",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| LogbookEvent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableGridLayouts/search": {
"post": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Search for SavedGridLayouts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAvailableGridLayouts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested savedgridlayout",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| LogbookEvent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableGridLayouts/searchCount": {
"post": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Returns number of hits in a search for SavedGridLayouts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAvailableGridLayouts",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| LogbookEvent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableGridLayouts/searchInfo": {
"get": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAvailableGridLayouts",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AvailableGridLayouts/{guid}/users": {
"get": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Fetches all users attached to the SavedGridLayout",
"operationId": "GetAvailableGridLayoutUsers",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid to fetch users for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the user for the SavedGridLayout",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| LogbookEvent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableGridLayouts/{guid}/users/{userNo}": {
"get": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Fetches a specific user attached to the SavedGridLayout",
"operationId": "GetAvailableGridLayoutUser",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The Guid to fetch users for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "userNo",
"in": "path",
"description": "The user no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the specific SavedGridLayoutUser for the SavedGridLayout",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| LogbookEvent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableGridLayouts/searchIndex/{guid}": {
"post": {
"tags": [
"AvailableGridLayouts"
],
"summary": "Get index of a record in a search for SavedGridLayouts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAvailableGridLayouts",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The SavedGridLayouts to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| LogbookEvent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableJobListWebSearch": {
"get": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Gets a list of SavedJobListWebSearch available in the job list for the current user",
"operationId": "GetAvailableJobListWebSearches",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Creates a new JobListWebSearch record",
"operationId": "CreateAvailableJobListWebSearch",
"requestBody": {
"description": "The JobListWebSearch Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableJobListWebSearch/{guid}": {
"get": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Gets a specific JobListWebSearch",
"operationId": "GetAvailableJobListWebSearch",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested JobListWebSearch",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an JobListWebSearch with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Updates an existing JobListWebSearch",
"operationId": "UpdateAvailableJobListWebSearch",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid of the JobListWebSearch to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The JobListWebSearch DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobListWebSearch object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Deletes a JobListWebSearch record",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The Guid of the JobListWebSearch to delete",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableJobListWebSearch/search": {
"post": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Search for SavedJobListWebSearch\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchAvailableJobListWebSearches",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested JobListWebSearch",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableJobListWebSearch/searchCount": {
"post": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Returns number of hits in a search for SavedJobListWebSearch\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountAvailableJobListWebSearches",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableJobListWebSearch/searchInfo": {
"get": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoAvailableJobListWebSearches",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/AvailableJobListWebSearch/searchIndex/{guid}": {
"post": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Get index of a record in a search for AvailableJobListWebSearch\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexAvailableJobListWebSearches",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The AvailableJobListWebSearch to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableJobListWebSearch/{guid}/users": {
"get": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Fetches all users attached to the JobListWebSearch",
"operationId": "GetAvailableJobListWebSearchUsers",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid to fetch users for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the user for the JobListWebSearch",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/AvailableJobListWebSearch/{guid}/users/{userNo}": {
"get": {
"tags": [
"AvailableJobListWebSearch"
],
"summary": "Fetches a specific user attached to the JobListWebSearch",
"operationId": "GetAvailablJobListWebSearchUser",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The Guid to fetch users for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "userNo",
"in": "path",
"description": "The user no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the specific JobListWebSearchUser for the JobListWebSearch",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MaintenancePlanning | View |
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations": {
"get": {
"tags": [
"BrbOperations"
],
"summary": "Gets a list of BrbOperations",
"operationId": "GetBrbOperations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"BrbOperations"
],
"summary": "Creates a new brbOperation record together with Soundings",
"operationId": "CreateBrbOperation",
"requestBody": {
"description": "The BrbOperation and Soudings wrapper Object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperationCreate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperationCreate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperationCreate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperationCreate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/{operationNo}": {
"get": {
"tags": [
"BrbOperations"
],
"summary": "Gets a specific BrbOperation",
"operationId": "GetBrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested brbOperation",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an brbOperation with the supplied BrbOperation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"BrbOperations"
],
"summary": "Updates an existing BrbOperation",
"operationId": "UpdateBrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the brbOperation to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The BrbOperation DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated BrbOperation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"BrbOperations"
],
"summary": "Deletes a brbOperation record",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the BrbOperation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/{operationNo}/history": {
"get": {
"tags": [
"BrbOperations"
],
"summary": "Gets history for a specific BrbOperation",
"operationId": "GetBrbOperationHistory",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested brbOperation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an brbOperation with the supplied BrbOperation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/search": {
"post": {
"tags": [
"BrbOperations"
],
"summary": "Search for BrbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchBrbOperations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested brbOperation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/searchIndex/{brbOperationGuid}": {
"post": {
"tags": [
"BrbOperations"
],
"summary": "Get index of a record in a search for brbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexBrbOperations",
"parameters": [
{
"name": "brbOperationGuid",
"in": "path",
"description": "The brbOperation to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/searchCount": {
"post": {
"tags": [
"BrbOperations"
],
"summary": "Returns number of hits in a search for BrbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountBrbOperations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/searchInfo": {
"get": {
"tags": [
"BrbOperations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoBrbOperations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/BrbOperations/{operationNo}/copy": {
"get": {
"tags": [
"BrbOperations"
],
"summary": "Copies an existing BrbOperation to a new object",
"operationId": "CopyBrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the brbOperation to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new BrbOperation object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/{operationNo}/force": {
"delete": {
"tags": [
"BrbOperations"
],
"summary": "Deletes a brbOperation record",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the BrbOperation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/{operationNo}/Documents": {
"get": {
"tags": [
"BrbOperations"
],
"summary": "Returns a list of Documents on the BrbOperation",
"operationId": "GetBrbOperationDocumentLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/{operationNo}/Soundings": {
"get": {
"tags": [
"BrbOperations"
],
"summary": "Returns a list of Soundings on the BrbOperation",
"operationId": "GetBrbOperationSoundingLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/{operationNo}/Receivers": {
"get": {
"tags": [
"BrbOperations"
],
"summary": "Returns a list of Receivers on the BrbOperation",
"operationId": "GetBrbOperationReceiverLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperationBrbReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperationBrbReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperationBrbReceiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/{operationNo}/Signers": {
"get": {
"tags": [
"BrbOperations"
],
"summary": "Returns a list of Signers on the BrbOperation",
"operationId": "GetBrbOperationSignersLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.BrbOperationSigner"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.BrbOperationSigner"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.BrbOperationSigner"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/{operationNo}/Documents/{documentNo}": {
"get": {
"tags": [
"BrbOperations"
],
"summary": "Returns a specific Document on the Certificate",
"operationId": "GetBrbOperationDocumentLink",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/GetPrintoutForBrbOperations": {
"post": {
"tags": [
"BrbOperations"
],
"operationId": "GetPrintoutForBrbOperations",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/GetLatestBrbOperationEndTime": {
"get": {
"tags": [
"BrbOperations"
],
"operationId": "GetLatestBrbOperationEndTime",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "date-time"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/GetPrintoutTableDataForOperations": {
"post": {
"tags": [
"BrbOperations"
],
"operationId": "GetPrintoutTableDataForBrbOperations",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbOperations/sign": {
"post": {
"tags": [
"BrbOperations"
],
"summary": "Signs list of Operations",
"operationId": "SignBrbOperations",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated BrbOperation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbReceivers": {
"get": {
"tags": [
"BrbReceivers"
],
"summary": "Gets a list of Brb receivers",
"operationId": "GetBrbReceivers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"BrbReceivers"
],
"summary": "Creates a new BrbReceiver record",
"operationId": "CreateBrbReceiver",
"requestBody": {
"description": "The BrbReceiver Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbReceivers/{BrbReceiverNo}": {
"get": {
"tags": [
"BrbReceivers"
],
"summary": "Gets a specific BrbReceiver",
"operationId": "GetBrbReceiver",
"parameters": [
{
"name": "BrbReceiverNo",
"in": "path",
"description": "The BrbReceiverNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested BrbReceiver",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an BrbReceiver with the supplied BrbReceiver No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"BrbReceivers"
],
"summary": "Updates an existing BrbReceiver",
"operationId": "UpdateBrbReceiver",
"parameters": [
{
"name": "BrbReceiverNo",
"in": "path",
"description": "The BrbReceiverNo of the BrbReceiver to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The BrbReceiver DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated BrbReceiver object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbReceivers/{BrbReceiverNo}/history": {
"get": {
"tags": [
"BrbReceivers"
],
"summary": "Gets history for a specific BrbReceiver",
"operationId": "GetBrbReceiverHistory",
"parameters": [
{
"name": "BrbReceiverNo",
"in": "path",
"description": "The BrbReceiverNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested BrbReceiver",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an BrbReceiver with the supplied BrbReceiver No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbReceivers/search": {
"post": {
"tags": [
"BrbReceivers"
],
"summary": "Search for BrbReceivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchBrbReceivers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested BrbReceiver",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbReceivers/searchIndex/{BrbReceiverGuid}": {
"post": {
"tags": [
"BrbReceivers"
],
"summary": "Get index of a record in a search for BrbReceivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexBrbReceivers",
"parameters": [
{
"name": "BrbReceiverGuid",
"in": "path",
"description": "The BrbReceiver to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbReceivers/searchCount": {
"post": {
"tags": [
"BrbReceivers"
],
"summary": "Returns number of hits in a search for BrbReceivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountBrbReceivers",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbReceivers/searchInfo": {
"get": {
"tags": [
"BrbReceivers"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoBrbReceivers",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/BrbReceivers/{BrbReceiverNo}/copy": {
"get": {
"tags": [
"BrbReceivers"
],
"summary": "Copies an existing BrbReceiver to a new object",
"operationId": "CopyBrbReceiver",
"parameters": [
{
"name": "BrbReceiverNo",
"in": "path",
"description": "The BrbReceiverNo of the BrbReceiver to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new BrbReceiver object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbReceivers/{BrbReceiverNo}/Documents": {
"get": {
"tags": [
"BrbReceivers"
],
"summary": "Returns a list of Documents on the BrbReceiver",
"operationId": "GetBrbReceiverDocumentLinks",
"parameters": [
{
"name": "BrbReceiverNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbReceiverDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbReceiverDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbReceiverDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BrbReceivers/{BrbReceiverNo}/Documents/{documentNo}": {
"get": {
"tags": [
"BrbReceivers"
],
"summary": "Returns a specific Document on the BrbReceiver",
"operationId": "GetBrbReceiverDocumentLink",
"parameters": [
{
"name": "BrbReceiverNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbReceiverDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbReceiverDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbReceiverDocument"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BudgetAccrualExports": {
"get": {
"tags": [
"BudgetAccrualExports"
],
"summary": "Gets a list of Budget Accrual Exports",
"operationId": "GetBudgetAccrualExports",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BudgetAccrualExport.BudgetAccrualExport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BudgetAccrualExport.BudgetAccrualExport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BudgetAccrualExport.BudgetAccrualExport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BudgetAccrualExport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BudgetAccrualExports/{accrualExportNo}": {
"get": {
"tags": [
"BudgetAccrualExports"
],
"summary": "Gets a specific Budget Accrual Export by its AccrualExportNo",
"operationId": "GetBudgetAccrualExport",
"parameters": [
{
"name": "accrualExportNo",
"in": "path",
"description": "The AccrualExportNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested budget accrual export",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BudgetAccrualExport.BudgetAccrualExport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BudgetAccrualExport.BudgetAccrualExport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BudgetAccrualExport.BudgetAccrualExport"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a budget accrual export with the supplied AccrualExportNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BudgetAccrualExport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BudgetAccrualExports/search": {
"post": {
"tags": [
"BudgetAccrualExports"
],
"summary": "Search for Budget Accrual Exports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchBudgetAccrualExports",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BudgetAccrualExport.BudgetAccrualExport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BudgetAccrualExport.BudgetAccrualExport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BudgetAccrualExport.BudgetAccrualExport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BudgetAccrualExport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BudgetAccrualExports/searchCount": {
"post": {
"tags": [
"BudgetAccrualExports"
],
"summary": "Returns number of hits in a search for Budget Accrual Exports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountBudgetAccrualExports",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BudgetAccrualExport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BudgetAccrualExports/searchIndex/{budgetAccrualExportGuid}": {
"post": {
"tags": [
"BudgetAccrualExports"
],
"summary": "Get index of a record in a search for Budget Accrual Exports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexBudgetAccrualExports",
"parameters": [
{
"name": "budgetAccrualExportGuid",
"in": "path",
"description": "The budget accrual export to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| BudgetAccrualExport | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/BudgetAccrualExports/searchInfo": {
"get": {
"tags": [
"BudgetAccrualExports"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoBudgetAccrualExports",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Budgets": {
"get": {
"tags": [
"Budgets"
],
"summary": "Gets a list of Budgets",
"operationId": "GetProcurementBudgets",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementBudget | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Budgets"
],
"summary": "Creates a new Budget record",
"operationId": "CreateBudget",
"requestBody": {
"description": "The Budget Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementBudget_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Budgets/{budgetNo}": {
"get": {
"tags": [
"Budgets"
],
"summary": "Gets a specific Budget",
"operationId": "GetProcurementBudget",
"parameters": [
{
"name": "budgetNo",
"in": "path",
"description": "The BudgetNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested budget",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a budget with the supplied Budget No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementBudget | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Budgets/{BudgetNo}": {
"delete": {
"tags": [
"Budgets"
],
"summary": "Deletes a Budget record",
"parameters": [
{
"name": "BudgetNo",
"in": "path",
"description": "The BudgetNo of the Budget to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementBudget_Delete | Delete |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Budgets/{budgetNo}/Responses": {
"get": {
"tags": [
"Budgets"
],
"summary": "Returns a list of Responses from the Budget",
"operationId": "GetProcurementBudgetResponses",
"parameters": [
{
"name": "budgetNo",
"in": "path",
"description": "The BudgetNo to fetch reponses for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the responses for the budget",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementBudget | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Budgets/{budgetNo}/Approvers": {
"get": {
"tags": [
"Budgets"
],
"summary": "Returns a list of Approvers from the Budget",
"operationId": "GetProcurementBudgetApprovers",
"parameters": [
{
"name": "budgetNo",
"in": "path",
"description": "The BudgetNo to fetch approvers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the approvers for the budget",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetApprover"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetApprover"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetApprover"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementBudget | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Budgets/{budgetNo}/BudgetLines": {
"get": {
"tags": [
"Budgets"
],
"summary": "Returns a list of Budget Lines from the Budget",
"operationId": "GetProcurementBudgetLines",
"parameters": [
{
"name": "budgetNo",
"in": "path",
"description": "The BudgetNo to fetch Budget Lines for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Budget Lines for the budget",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetLine"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetLine"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetLine"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementBudget | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Budgets/search": {
"post": {
"tags": [
"Budgets"
],
"summary": "Search for Budgets\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchBudgets",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.Budget"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementBudget | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Budgets/searchIndex/{budgetGuid}": {
"post": {
"tags": [
"Budgets"
],
"summary": "Get index of a record in a search for budgets\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexBudgets",
"parameters": [
{
"name": "budgetGuid",
"in": "path",
"description": "The budget to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementBudget | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Budgets/searchCount": {
"post": {
"tags": [
"Budgets"
],
"summary": "Returns number of hits in a search for Budgets\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountBudgets",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementBudget | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CalculatePurchaseOrder/availableSuppliers": {
"post": {
"tags": [
"CalculatePurchaseOrder"
],
"operationId": "CalculatePOGetAvailableSuppliers",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOSupplier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOSupplier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOSupplier"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CalculatePurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CalculatePurchaseOrder/availablePositions": {
"post": {
"tags": [
"CalculatePurchaseOrder"
],
"operationId": "CalculatePOGetAvailablePositions",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOPosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOPosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOPosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CalculatePurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CalculatePurchaseOrder/availablePorts": {
"post": {
"tags": [
"CalculatePurchaseOrder"
],
"operationId": "CalculatePOGetAvailablePorts",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOPort"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOPort"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOPort"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CalculatePurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CalculatePurchaseOrder": {
"post": {
"tags": [
"CalculatePurchaseOrder"
],
"operationId": "CalculatePOCreatePurchaseOrders",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOCreateArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOCreateArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOCreateArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOCreateArguments"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.ApiCalculatePOSaveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.ApiCalculatePOSaveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.ApiCalculatePOSaveResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CalculatePurchaseOrder/setupCreatePurchaseOrders": {
"post": {
"tags": [
"CalculatePurchaseOrder"
],
"operationId": "CalculatePOSetupCreatePurchaseOrders",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOCreateArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOCreateArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOCreateArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOCreateArguments"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.ApiCalculatePOSaveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.ApiCalculatePOSaveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CalculatePurchaseOrder.ApiCalculatePOSaveResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CalculatePurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers": {
"get": {
"tags": [
"Carriers"
],
"summary": "Gets a list of Carriers",
"operationId": "GetCarriers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Returns all Carriers",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Carriers"
],
"summary": "Creates a new Carrier record",
"operationId": "CreateCarrier",
"requestBody": {
"description": "The Carrier Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
},
"responses": {
"201": {
"description": "Returns the created Carrier object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Carrier_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/{carrierNo}": {
"get": {
"tags": [
"Carriers"
],
"summary": "Gets a specific Carrier",
"operationId": "GetCarrier",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "The Carrier No to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Carrier",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Carrier with the supplied Carrier No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Carriers"
],
"summary": "Updates an existing Carrier",
"operationId": "UpdateCarrier",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "The Carrier No of the Carrier to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Carrier DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Carrier object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Carrier with the supplied Carrier No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Carrier_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Carriers"
],
"summary": "Deletes a Carrier record",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "The Carrier No of the Carrier to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Returns NoContent result if the Carrier is succesfully deleted"
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Carrier with the supplied Carrier No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Carrier_Delete | Delete |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/search": {
"post": {
"tags": [
"Carriers"
],
"summary": "Search for Carriers.\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCarriers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page Size",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns all Carriers matching the search criteria",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/searchCount": {
"post": {
"tags": [
"Carriers"
],
"summary": "Returns number of hits in a search for Carriers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCarriers",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns number of hits in a search for Carriers",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/searchIndex/{carrierGuid}": {
"post": {
"tags": [
"Carriers"
],
"summary": "Get index of a record in a search for Carriers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCarriers",
"parameters": [
{
"name": "carrierGuid",
"in": "path",
"description": "The carrier to find index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the index of a record in a search for Carriers or -1 if not found",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/searchInfo": {
"get": {
"tags": [
"Carriers"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "CarrierSearchInfo",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Carriers/{carrierNo}/documents": {
"get": {
"tags": [
"Carriers"
],
"summary": "Returns a list of Documents used on the Carrier",
"operationId": "GetCarrierDocuments",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "The Carrier No to fetch Documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Documents for the Carrier",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierDocument"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Carrier with the supplied Carrier No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/{carrierNo}/packages": {
"get": {
"tags": [
"Carriers"
],
"summary": "Returns a list of Packages used on the Carrier",
"operationId": "GetCarrierPackages",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "The Carrier No to fetch Packages for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Packages for the Carrier",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPackage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPackage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPackage"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Carrier with the supplied Carrier No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/{carrierNo}/positions": {
"get": {
"tags": [
"Carriers"
],
"summary": "Returns a list of Positions used on the Carrier",
"operationId": "GetCarrierPositions",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "The Carrier No to fetch Positions for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Positions for the Carrier",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPosition"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Carrier with the supplied Carrier No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/{carrierNo}/responses": {
"get": {
"tags": [
"Carriers"
],
"summary": "Gets a list of Carrier Responses",
"operationId": "GetCarrierResponses",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "The Carrier No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Responses for the Carrier",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Carrier with the supplied Carrier No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Carriers"
],
"summary": "Creates a new Carrier Response for the Carrier.",
"operationId": "CreateCarrierResponse",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "Carrier No from the URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Carrier Response retrieved from the body of the post request",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
}
}
}
},
"responses": {
"200": {
"description": "Returns the created Carrier Response object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Carrier with the supplied Carrier No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Carrier_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/{carrierNo}/responses/count": {
"get": {
"tags": [
"Carriers"
],
"summary": "Returns the number of Responses on a specific Carrier",
"operationId": "GetCarrierResponsesCount",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "The Carrier No to fetch the number of Responses for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Responses Count for the Carrier",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/labels/{labelTemplateDocumentNo}": {
"post": {
"tags": [
"Carriers"
],
"summary": "Gets the labels to print",
"operationId": "PrintCarrierLabels",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "the template No to print",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A Search Definition containing the carrier numbers to print",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested carrier report as pdf"
},
"404": {
"description": "If a carrier with the supplied Carrier No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/{carrierNo}/history": {
"get": {
"tags": [
"Carriers"
],
"summary": "Gets history for a specific Carrier",
"operationId": "GetCarrierHistory",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "The Carrier No to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested Carrier",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Carrier with the supplied Carrier No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Carrier_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/{CarrierNo}/copy": {
"get": {
"tags": [
"Carriers"
],
"summary": "Copies an existing Carrier to a new object",
"operationId": "CopyCarrier",
"parameters": [
{
"name": "CarrierNo",
"in": "path",
"description": "The CarrierNo of the Carrier to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Carrier object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Carrier_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/labels/{labelTemplateDocumentNo}/{settingsKey}": {
"get": {
"tags": [
"Carriers"
],
"summary": "Get the labels to print using settings key",
"operationId": "GetCarrierLabelPdf",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "The template No to print",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "settingsKey",
"in": "path",
"description": "The UUID for the stored search definition",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Carriers/{carrierNo}/shipments": {
"get": {
"tags": [
"Carriers"
],
"summary": "Gets a list of linked Shipments",
"operationId": "GetCarrierShipments",
"parameters": [
{
"name": "carrierNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateDocuments": {
"get": {
"tags": [
"CertificateDocuments"
],
"summary": "Gets a list of CertificateDocuments",
"operationId": "GetCertificateDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"CertificateDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateCertificateDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certificate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateDocuments/{documentNo}": {
"get": {
"tags": [
"CertificateDocuments"
],
"summary": "Gets a specific CertificateDocument",
"operationId": "GetCertificateDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"CertificateDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certificate_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"CertificateDocuments"
],
"summary": "Get index of a record in a search for CertificateDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCertificateDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateDocuments/{documentNo}/history": {
"get": {
"tags": [
"CertificateDocuments"
],
"summary": "Gets history for a specific CertificateDocument",
"operationId": "GetCertificateDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certificate_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateDocuments/search": {
"post": {
"tags": [
"CertificateDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCertificateDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateDocuments/searchCount": {
"post": {
"tags": [
"CertificateDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCertificateDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateDocuments/searchInfo": {
"get": {
"tags": [
"CertificateDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCertificateDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/CertificateDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"CertificateDocuments"
],
"summary": "",
"operationId": "GetCertificateDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateDocuments/{documentNo}/file": {
"get": {
"tags": [
"CertificateDocuments"
],
"summary": "",
"operationId": "GetCertificateDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"CertificateDocuments"
],
"operationId": "AddCertificateDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certificate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"CertificateDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetCertificateDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"CertificateDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetCertificateDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroupRules": {
"get": {
"tags": [
"CertificateGroupRules"
],
"summary": "Gets a list of CertificateGroupRules",
"operationId": "GetCertificateGroupRules",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroupRule | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"CertificateGroupRules"
],
"summary": "Creates a new certificateGroupRule record",
"operationId": "CreateCertificateGroupRule",
"requestBody": {
"description": "The certificateGroupRule Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroupRule_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroupRules/{certificateGroupRuleNo}": {
"get": {
"tags": [
"CertificateGroupRules"
],
"summary": "Gets a specific CertificateGroupRule",
"operationId": "GetCertificateGroupRule",
"parameters": [
{
"name": "certificateGroupRuleNo",
"in": "path",
"description": "the certificateGroupRuleNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested certificateGroupRule",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an certificateGroupRule with the supplied certificateGroupRule No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroupRule | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"CertificateGroupRules"
],
"summary": "Updates an existing CertificateGroupRule",
"operationId": "UpdateCertificateGroupRule",
"parameters": [
{
"name": "certificateGroupRuleNo",
"in": "path",
"description": "The CertificateGroupRuleNo of the CertificateGroupRule to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The CertificateGroupRule DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated CertificateGroupRule object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroupRule_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"CertificateGroupRules"
],
"summary": "Deletes an certificateGroupRule record",
"parameters": [
{
"name": "certificateGroupRuleNo",
"in": "path",
"description": "The certificateGroupRuleNo of the certificateGroupRule to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroupRule_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroupRules/{certificateGroupRuleNo}/history": {
"get": {
"tags": [
"CertificateGroupRules"
],
"summary": "Gets history for a specific certificateGroupRule",
"operationId": "GetCertificateGroupRuleHistory",
"parameters": [
{
"name": "certificateGroupRuleNo",
"in": "path",
"description": "The certificateGroupRuleNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested CertificateGroupRule",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an CertificateGroupRule with the supplied CertificateGroupRule No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroupRule_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroupRules/search": {
"post": {
"tags": [
"CertificateGroupRules"
],
"summary": "Search for CertificateGroupRules\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCertificateGroupRules",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroupRule | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroupRules/searchCount": {
"post": {
"tags": [
"CertificateGroupRules"
],
"summary": "Returns number of hits in a search for CertificateGroupRules\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCertificateGroupRules",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroupRule | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroupRules/searchIndex/{certificateGroupRuleGuid}": {
"post": {
"tags": [
"CertificateGroupRules"
],
"summary": "Get index of a record in a search for CertificateGroupRules\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCertificateGroupRules",
"parameters": [
{
"name": "certificateGroupRuleGuid",
"in": "path",
"description": "The CertificateGroupRule to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroupRule | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroupRules/searchInfo": {
"get": {
"tags": [
"CertificateGroupRules"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCertificateGroupRules",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/CertificateGroupRules/{certificateGroupRuleNo}/copy": {
"get": {
"tags": [
"CertificateGroupRules"
],
"summary": "Copies an existing certificateGroupRule to a new object",
"operationId": "CopyCertificateGroupRule",
"parameters": [
{
"name": "certificateGroupRuleNo",
"in": "path",
"description": "The certificateGroupRuleNo of the certificateGroupRule to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new certificateGroupRule object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroupRule_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroups": {
"get": {
"tags": [
"CertificateGroups"
],
"summary": "Gets a list of CertificateGroups",
"operationId": "GetCertificateGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"CertificateGroups"
],
"summary": "Creates a new certificateGroup record",
"operationId": "CreateCertificateGroup",
"requestBody": {
"description": "The certificateGroup Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroups/{certificateGroupID}": {
"get": {
"tags": [
"CertificateGroups"
],
"summary": "Gets a specific CertificateGroup",
"operationId": "GetCertificateGroup",
"parameters": [
{
"name": "certificateGroupID",
"in": "path",
"description": "the certificateGroupID to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested certificateGroup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an certificateGroup with the supplied certificateGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"CertificateGroups"
],
"summary": "Updates an existing CertificateGroup",
"operationId": "UpdateCertificateGroup",
"parameters": [
{
"name": "certificateGroupID",
"in": "path",
"description": "The certificateGroupID of the CertificateGroup to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The CertificateGroup DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated CertificateGroup object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"CertificateGroups"
],
"summary": "Deletes an certificateGroup record",
"parameters": [
{
"name": "certificateGroupID",
"in": "path",
"description": "The certificateGroupID of the certificateGroup to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroups/{certificateGroupID}/history": {
"get": {
"tags": [
"CertificateGroups"
],
"summary": "Gets history for a specific certificateGroup",
"operationId": "GetCertificateGroupHistory",
"parameters": [
{
"name": "certificateGroupID",
"in": "path",
"description": "The certificateGroupID to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested CertificateGroup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an CertificateGroup with the supplied CertificateGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroups/search": {
"post": {
"tags": [
"CertificateGroups"
],
"summary": "Search for CertificateGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCertificateGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroups/searchCount": {
"post": {
"tags": [
"CertificateGroups"
],
"summary": "Returns number of hits in a search for CertificateGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCertificateGroups",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroups/searchIndex/{certificateGroupGuid}": {
"post": {
"tags": [
"CertificateGroups"
],
"summary": "Get index of a record in a search for CertificateGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCertificateGroups",
"parameters": [
{
"name": "certificateGroupGuid",
"in": "path",
"description": "The CertificateGroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroups/searchInfo": {
"get": {
"tags": [
"CertificateGroups"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCertificateGroups",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/CertificateGroups/{certificateGroupID}/copy": {
"get": {
"tags": [
"CertificateGroups"
],
"summary": "Copies an existing certificateGroup to a new object",
"operationId": "CopyCertificateGroup",
"parameters": [
{
"name": "certificateGroupID",
"in": "path",
"description": "The certificateGroupID of the certificateGroup to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new certificateGroup object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroups/{certificateGroupID}/vesselTypes": {
"get": {
"tags": [
"CertificateGroups"
],
"summary": "Returns a list of Certificate Group Vessel Types for a specific Certificate Group",
"operationId": "GetCertificateGroupVesselTypes",
"parameters": [
{
"name": "certificateGroupID",
"in": "path",
"description": "The Certificate Group No to fetch items for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Certificate Group Vessel Types for the Certificate Group",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupVesselType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupVesselType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupVesselType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroups/{groupID}/Rule": {
"get": {
"tags": [
"CertificateGroups"
],
"summary": "Returns the Certificate Group Rule of requested Certificate Group",
"operationId": "GetCertificateGroupRuleByGroupId",
"parameters": [
{
"name": "groupID",
"in": "path",
"description": "The Certificate Group No to fetch items for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Certificate Group Rule for the requested Certificate Group",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupRule"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup | View |
| CertificateGroupRule | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateGroups/{groupID}/notificationSettings": {
"get": {
"tags": [
"CertificateGroups"
],
"summary": "Gets usages for a specific Certificate Group",
"operationId": "GetNotificationSettingsForCertificateGroup",
"parameters": [
{
"name": "groupID",
"in": "path",
"description": "The Group ID to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a list of CertificateNotificationSettings attached to the requested certificate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a certificate with the supplied Certificate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup | View |
| CertificateNotiSetting | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateLocations": {
"get": {
"tags": [
"CertificateLocations"
],
"summary": "Gets a list of CertificateLocations",
"operationId": "GetCertificateLocations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"CertificateLocations"
],
"summary": "Creates a new certificateLocation record",
"operationId": "CreateCertificateLocation",
"requestBody": {
"description": "The certificateLocation Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateLocations/{certificateLocationNo}": {
"get": {
"tags": [
"CertificateLocations"
],
"summary": "Gets a specific CertificateLocation",
"operationId": "GetCertificateLocation",
"parameters": [
{
"name": "certificateLocationNo",
"in": "path",
"description": "the certificateLocationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested certificateLocation",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an certificateLocation with the supplied certificateLocation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"CertificateLocations"
],
"summary": "Updates an existing CertificateLocation",
"operationId": "UpdateCertificateLocation",
"parameters": [
{
"name": "certificateLocationNo",
"in": "path",
"description": "The certificateLocationNo of the CertificateLocation to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The CertificateLocation DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated CertificateLocation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"CertificateLocations"
],
"summary": "Deletes an certificateLocation record",
"parameters": [
{
"name": "certificateLocationNo",
"in": "path",
"description": "The certificateLocationNo of the certificateLocation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateLocations/{certificateLocationNo}/history": {
"get": {
"tags": [
"CertificateLocations"
],
"summary": "Gets history for a specific certificateLocation",
"operationId": "GetCertificateLocationHistory",
"parameters": [
{
"name": "certificateLocationNo",
"in": "path",
"description": "The certificateLocationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested CertificateLocation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an CertificateLocation with the supplied CertificateLocation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateLocations/search": {
"post": {
"tags": [
"CertificateLocations"
],
"summary": "Search for CertificateLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCertificateLocations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateLocations/searchCount": {
"post": {
"tags": [
"CertificateLocations"
],
"summary": "Returns number of hits in a search for CertificateLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCertificateLocations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateLocations/searchIndex/{certificateLocationGuid}": {
"post": {
"tags": [
"CertificateLocations"
],
"summary": "Get index of a record in a search for CertificateLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCertificateLocations",
"parameters": [
{
"name": "certificateLocationGuid",
"in": "path",
"description": "The CertificateLocation to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateLocations/searchInfo": {
"get": {
"tags": [
"CertificateLocations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCertificateLocations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/CertificateLocations/{certificateLocationNo}/copy": {
"get": {
"tags": [
"CertificateLocations"
],
"summary": "Copies an existing certificateLocation to a new object",
"operationId": "CopyCertificateLocation",
"parameters": [
{
"name": "certificateLocationNo",
"in": "path",
"description": "The certificateLocationNo of the certificateLocation to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new certificateLocation object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateLocations/{certificateLocationNo}/certificateGroups": {
"get": {
"tags": [
"CertificateLocations"
],
"summary": "Returns a list of Certificate Location Certificate Groups for a specific Certificate Location",
"operationId": "GetCertificateLocationCertificateGroups",
"parameters": [
{
"name": "certificateLocationNo",
"in": "path",
"description": "The Certificate Location No to fetch items for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Certificate Location Certificate Groups for the Certificate Location",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocationCertificateGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocationCertificateGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocationCertificateGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateNotificationSettings": {
"get": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Gets a list of CertificateNotificationSettings",
"operationId": "GetCertificateNotificationSettings",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateNotiSetting | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Creates a new certificate Notification Setting record",
"operationId": "CreateCertificateNotificationSetting",
"requestBody": {
"description": "The certificateNotificationSetting Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateNotiSetting_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateNotificationSettings/{certificateNotificationSettingNo}": {
"get": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Gets a specific CertificateNotificationSetting",
"operationId": "GetCertificateNotificationSetting",
"parameters": [
{
"name": "certificateNotificationSettingNo",
"in": "path",
"description": "the certificateNotificationSettingNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested certificateNotificationSetting",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an certificateNotificationSetting with the supplied certificateNotificationSetting No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateNotiSetting | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Updates an existing Certificate Notification Setting",
"operationId": "UpdateCertificateNotificationSetting",
"parameters": [
{
"name": "certificateNotificationSettingNo",
"in": "path",
"description": "The certificateNotificationSettingNo of the CertificateNotificationSetting to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The CertificateNotificationSetting DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated CertificateNotificationSetting object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateNotiSetting_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Deletes an certificate Notification Setting record",
"parameters": [
{
"name": "certificateNotificationSettingNo",
"in": "path",
"description": "The certificate Notification Setting No of the certificate Notification Setting to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateNotiSetting_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateNotificationSettings/{certificateNotificationSettingNo}/history": {
"get": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Gets history for a specific certificateNotificationSetting",
"operationId": "GetCertificateNotificationSettingHistory",
"parameters": [
{
"name": "certificateNotificationSettingNo",
"in": "path",
"description": "The certificateNotificationSettingNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested CertificateNotificationSetting",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an CertificateNotificationSetting with the supplied CertificateNotificationSetting No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateNotiSetting_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateNotificationSettings/search": {
"post": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Search for CertificateNotificationSettings\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCertificateNotificationSettings",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateNotiSetting | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateNotificationSettings/searchCount": {
"post": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Returns number of hits in a search for CertificateNotificationSettings\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCertificateNotificationSettings",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateNotiSetting | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateNotificationSettings/searchIndex/{certificateNotificationSettingGuid}": {
"post": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Get index of a record in a search for CertificateNotificationSettings\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCertificateNotificationSettings",
"parameters": [
{
"name": "certificateNotificationSettingGuid",
"in": "path",
"description": "The CertificateNotificationSetting to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateNotiSetting | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateNotificationSettings/searchInfo": {
"get": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCertificateNotificationSettings",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/CertificateNotificationSettings/{certificateNotificationSettingNo}/copy": {
"get": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Copies an existing certificate Notification Setting to a new object",
"operationId": "CopyCertificateNotificationSetting",
"parameters": [
{
"name": "certificateNotificationSettingNo",
"in": "path",
"description": "The certificateNotificationSettingNo of the certificateNotificationSetting to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new certificateNotificationSetting object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSetting"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateNotiSetting_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateNotificationSettings/{certificateNotificationSettingNo}/certificateGroups": {
"get": {
"tags": [
"CertificateNotificationSettings"
],
"summary": "Returns a list of Certificate Notification Setting Certificate Groups for a specific Certificate NotificationSetting",
"operationId": "GetCertificateNotificationSettingCertificateGroups",
"parameters": [
{
"name": "certificateNotificationSettingNo",
"in": "path",
"description": "The Certificate NotificationSetting No to fetch items for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Certificate NotificationSetting Certificate Groups for the Certificate NotificationSetting",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates": {
"get": {
"tags": [
"Certificates"
],
"summary": "Gets a list of Certificates",
"operationId": "GetCertificates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Certificates"
],
"summary": "Creates a new certificate record",
"operationId": "CreateCertificate",
"requestBody": {
"description": "The Certificate Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certificate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/{certificateNo}": {
"get": {
"tags": [
"Certificates"
],
"summary": "Gets a specific Certificate",
"operationId": "GetCertificate",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"description": "the certificateNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested certificate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an certificate with the supplied Certificate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Certificates"
],
"summary": "Updates an existing Certificate",
"operationId": "UpdateCertificate",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"description": "The certificateNo of the certificate to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Certificate DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Certificate object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certificate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Certificates"
],
"summary": "Deletes an certificate record",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"description": "The certificateNo of the Certificate to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certificate_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/{certificateNo}/history": {
"get": {
"tags": [
"Certificates"
],
"summary": "Gets history for a specific Certificate",
"operationId": "GetCertificateHistory",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"description": "The certificateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested certificate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an certificate with the supplied Certificate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certificate_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/search": {
"post": {
"tags": [
"Certificates"
],
"summary": "Search for certificates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCertificates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/searchCount": {
"post": {
"tags": [
"Certificates"
],
"summary": "Returns number of hits in a search for Certificates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCertificates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/searchIndex/{certificateGuid}": {
"post": {
"tags": [
"Certificates"
],
"summary": "Get index of a record in a search for Certificates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCertificates",
"parameters": [
{
"name": "certificateGuid",
"in": "path",
"description": "The certificate to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/searchInfo": {
"get": {
"tags": [
"Certificates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCertificates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Certificates/{certificateNo}/copy": {
"get": {
"tags": [
"Certificates"
],
"summary": "Copies an existing certificate to a new object",
"operationId": "CopyCertificate",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"description": "The CertificateNo of the certificate to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Certificate object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certificate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/{certificateNo}/Documents": {
"get": {
"tags": [
"Certificates"
],
"summary": "Returns a list of Documents on the Certificate",
"operationId": "GetCertificateDocumentLinks",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/{certificateNo}/Documents/{no}": {
"get": {
"tags": [
"Certificates"
],
"summary": "Returns a specific Document on the Certificate",
"operationId": "GetCertificateDocumentLink",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "no",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateDocument"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/search/{certificateGroupId}": {
"post": {
"tags": [
"Certificates"
],
"summary": "Search for certificates using a specific CertificateGroup\r\nTakes a Certificate Group No. and a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCertificatesByGroupNo",
"parameters": [
{
"name": "certificateGroupId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.Certificate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/searchInfo/{certificateGroupId}": {
"get": {
"tags": [
"Certificates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCertificatesByGroupNo",
"parameters": [
{
"name": "certificateGroupId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a list of valid search fields based on the given Certificate Group",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/searchCount/{certificateGroupId}": {
"post": {
"tags": [
"Certificates"
],
"summary": "Returns number of hits in a search for Certificates using a specific Certificate Group\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCertificatesByGroupNo",
"parameters": [
{
"name": "certificateGroupId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/searchIndex/{certificateGuid}/{certificateGroupId}": {
"post": {
"tags": [
"Certificates"
],
"summary": "Get index of a record in a search for Certificates using a specific Certificate Group\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCertificatesByGroupNo",
"parameters": [
{
"name": "certificateGuid",
"in": "path",
"description": "The certificate to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "certificateGroupId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/send": {
"post": {
"tags": [
"Certificates"
],
"summary": "Send Certificates",
"operationId": "SendCertificates",
"requestBody": {
"description": "The CertificateMail DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateMail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateMail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateMail"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateMail"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/{certificateNo}/responses": {
"get": {
"tags": [
"Certificates"
],
"summary": "Gets a list of Certificate Responses",
"operationId": "GetCertificateResponses",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"description": "The Certificate No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Certificates"
],
"summary": "Add response",
"operationId": "AddCertificateResponse",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"description": "The Certificate No. to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The CertificateResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certificate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/{certificateNo}/responses/count": {
"get": {
"tags": [
"Certificates"
],
"summary": "Returns number of Certificate Responses",
"operationId": "CertificateResponseCount",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"description": "The Certificate No.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/zipArchive": {
"post": {
"tags": [
"Certificates"
],
"operationId": "ZipCertificateArchive",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "The name for the Zip file",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns a zip file of the searched forms"
},
"404": {
"description": ""
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/{certificateNo}/renew": {
"post": {
"tags": [
"Certificates"
],
"summary": "",
"operationId": "RenewCertificate",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "imageDimension",
"in": "query",
"description": "",
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
}
},
{
"name": "imageQuality",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 80
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Certif_AllowRenew | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Certificates/{certificateNo}/notificationSettings": {
"get": {
"tags": [
"Certificates"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetNotificationSettingsForCertificate",
"parameters": [
{
"name": "certificateNo",
"in": "path",
"description": "The certificateNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a list of CertificateNotificationSettings attached to the requested certificate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a certificate with the supplied Certificate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CertificateGroup | View |
| CertificateNotiSetting | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateTree": {
"get": {
"tags": [
"CertificateTree"
],
"operationId": "GetCertificateRootNodes",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CertificateTree/{certificateGroupId}/children": {
"get": {
"tags": [
"CertificateTree"
],
"operationId": "GetCertificateGroupChildren",
"parameters": [
{
"name": "certificateGroupId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestCriticalities": {
"get": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Gets a list of ChangeRequestCriticalities",
"operationId": "GetChangeRequestCriticalities",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestCriticality | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Creates a new ChangeRequestCriticality record",
"operationId": "CreateChangeRequestCriticality",
"requestBody": {
"description": "The ChangeRequestCriticality Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestCriticality_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestCriticalities/{criticalityNo}": {
"get": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Gets a specific ChangeRequestCriticality",
"operationId": "GetChangeRequestCriticality",
"parameters": [
{
"name": "CriticalityNo",
"in": "path",
"description": "The CriticalityNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested ChangeRequestCriticality",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ChangeRequestCriticality with the supplied Criticality No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestCriticality | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Updates an existing ChangeRequestCriticality",
"operationId": "UpdateChangeRequestCriticality",
"parameters": [
{
"name": "CriticalityNo",
"in": "path",
"description": "The CriticalityNo of the ChangeRequestCriticality to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ChangeRequestCriticality DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ChangeRequestCriticality object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestCriticality_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Deletes a ChangeRequestCriticality record",
"parameters": [
{
"name": "CriticalityNo",
"in": "path",
"description": "The CriticalityNo of the ChangeRequestCriticality to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestCriticality_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestCriticalities/{criticalityNo}/history": {
"get": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Gets history for a specific ChangeRequestCriticality",
"operationId": "GetChangeRequestCriticalityHistory",
"parameters": [
{
"name": "CriticalityNo",
"in": "path",
"description": "The CriticalityNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested ChangeRequestCriticality",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ChangeRequestCriticality with the supplied Criticality No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestCriticality_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestCriticalities/search": {
"post": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Search for ChangeRequestCriticalities\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchChangeRequestCriticalities",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested ChangeRequestCriticality",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestCriticality | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestCriticalities/searchIndex/{ChangeRequestCriticalityGuid}": {
"post": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Get index of a record in a search for changeRequestCriticalities\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexChangeRequestCriticalities",
"parameters": [
{
"name": "ChangeRequestCriticalityGuid",
"in": "path",
"description": "The ChangeRequestCriticality to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestCriticality | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestCriticalities/searchCount": {
"post": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Returns number of hits in a search for ChangeRequestCriticalities\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountChangeRequestCriticalities",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestCriticality | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestCriticalities/searchInfo": {
"get": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoChangeRequestCriticalities",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ChangeRequestCriticalities/{criticalityNo}/copy": {
"get": {
"tags": [
"ChangeRequestCriticalities"
],
"summary": "Copies an existing ChangeRequestCriticality to a new object",
"operationId": "CopyChangeRequestCriticality",
"parameters": [
{
"name": "CriticalityNo",
"in": "path",
"description": "The CriticalityNo of the ChangeRequestCriticality to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ChangeRequestCriticality object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestCriticality_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments": {
"get": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Gets a list of ChangeRequestDocuments",
"operationId": "GetChangeRequestDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateChangeRequestDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/{documentNo}": {
"get": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Gets a specific ChangeRequestDocument",
"operationId": "GetChangeRequestDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Updates an existing Document",
"operationId": "UpdateChangeRequestDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Get index of a record in a search for ChangeRequestDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexChangeRequestDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/{documentNo}/history": {
"get": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Gets history for a specific ChangeRequestDocument",
"operationId": "GetChangeRequestDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/search": {
"post": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchChangeRequestDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/searchCount": {
"post": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountChangeRequestDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/searchInfo": {
"get": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoChangeRequestDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ChangeRequestDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "",
"operationId": "GetChangeRequestDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/{documentNo}/file": {
"get": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "",
"operationId": "GetChangeRequestDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ChangeRequestDocuments"
],
"operationId": "AddChangeRequestDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetChangeRequestDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetChangeRequestDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/{documentNo}/checkout": {
"put": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutChangeRequestDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestDocuments/{documentNo}/checkin": {
"post": {
"tags": [
"ChangeRequestDocuments"
],
"summary": "",
"operationId": "CheckinChangeRequestDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestSources": {
"get": {
"tags": [
"ChangeRequestSources"
],
"summary": "Gets a list of ChangeRequestSources",
"operationId": "GetChangeRequestSources",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestSource | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ChangeRequestSources"
],
"summary": "Creates a new ChangeRequestSource record",
"operationId": "CreateChangeRequestSource",
"requestBody": {
"description": "The ChangeRequestSource Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestSource_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestSources/{sourceNo}": {
"get": {
"tags": [
"ChangeRequestSources"
],
"summary": "Gets a specific ChangeRequestSource",
"operationId": "GetChangeRequestSource",
"parameters": [
{
"name": "SourceNo",
"in": "path",
"description": "The SourceNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested ChangeRequestSource",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ChangeRequestSource with the supplied Source No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestSource | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ChangeRequestSources"
],
"summary": "Updates an existing ChangeRequestSource",
"operationId": "UpdateChangeRequestSource",
"parameters": [
{
"name": "SourceNo",
"in": "path",
"description": "The SourceNo of the ChangeRequestSource to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ChangeRequestSource DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ChangeRequestSource object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestSource_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ChangeRequestSources"
],
"summary": "Deletes a ChangeRequestSource record",
"parameters": [
{
"name": "SourceNo",
"in": "path",
"description": "The SourceNo of the ChangeRequestSource to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestSource_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestSources/{sourceNo}/history": {
"get": {
"tags": [
"ChangeRequestSources"
],
"summary": "Gets history for a specific ChangeRequestSource",
"operationId": "GetChangeRequestSourceHistory",
"parameters": [
{
"name": "SourceNo",
"in": "path",
"description": "The SourceNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested ChangeRequestSource",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ChangeRequestSource with the supplied Source No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestSource_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestSources/search": {
"post": {
"tags": [
"ChangeRequestSources"
],
"summary": "Search for ChangeRequestSources\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchChangeRequestSources",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested ChangeRequestSource",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestSource | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestSources/searchIndex/{ChangeRequestSourceGuid}": {
"post": {
"tags": [
"ChangeRequestSources"
],
"summary": "Get index of a record in a search for changeRequestSources\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexChangeRequestSources",
"parameters": [
{
"name": "ChangeRequestSourceGuid",
"in": "path",
"description": "The ChangeRequestSource to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestSource | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestSources/searchCount": {
"post": {
"tags": [
"ChangeRequestSources"
],
"summary": "Returns number of hits in a search for ChangeRequestSources\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountChangeRequestSources",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestSource | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ChangeRequestSources/searchInfo": {
"get": {
"tags": [
"ChangeRequestSources"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoChangeRequestSources",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ChangeRequestSources/{sourceNo}/copy": {
"get": {
"tags": [
"ChangeRequestSources"
],
"summary": "Copies an existing ChangeRequestSource to a new object",
"operationId": "CopyChangeRequestSource",
"parameters": [
{
"name": "SourceNo",
"in": "path",
"description": "The SourceNo of the ChangeRequestSource to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ChangeRequestSource object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ChangeRequestSource"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequestSource_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassCodes": {
"get": {
"tags": [
"ClassCodes"
],
"summary": "Gets a list of ClassCodes",
"operationId": "GetClassCodes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ClassCodes"
],
"summary": "Creates a new classCode record",
"operationId": "CreateClassCode",
"requestBody": {
"description": "The ClassCode Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ClassCode_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassCodes/{classCodeNo}": {
"get": {
"tags": [
"ClassCodes"
],
"summary": "Gets a specific ClassCode",
"operationId": "GetClassCode",
"parameters": [
{
"name": "classCodeNo",
"in": "path",
"description": "The ClassCodeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested classCode",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an classCode with the supplied ClassCode No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ClassCodes"
],
"summary": "Updates an existing ClassCode",
"operationId": "UpdateClassCode",
"parameters": [
{
"name": "classCodeNo",
"in": "path",
"description": "The ClassCodeNo of the classCode to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ClassCode DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ClassCode object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ClassCode_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassCodes/{classCodeNo}/history": {
"get": {
"tags": [
"ClassCodes"
],
"summary": "Gets history for a specific ClassCode",
"operationId": "GetClassCodeHistory",
"parameters": [
{
"name": "classCodeNo",
"in": "path",
"description": "The ClassCodeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested classCode",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an classCode with the supplied ClassCode No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ClassCode_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassCodes/search": {
"post": {
"tags": [
"ClassCodes"
],
"summary": "Search for ClassCodes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchClassCodes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassCodes/searchIndex/{guid}": {
"post": {
"tags": [
"ClassCodes"
],
"summary": "Get index of a record in a search for ClassCodes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexClassCodes",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The classCode to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassCodes/searchCount": {
"post": {
"tags": [
"ClassCodes"
],
"summary": "Returns number of hits in a search for ClassCodes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountClassCodes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassCodes/searchInfo": {
"get": {
"tags": [
"ClassCodes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoClassCodes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ClassCodes/{ClassCodeNo}": {
"delete": {
"tags": [
"ClassCodes"
],
"summary": "Deletes a ClassCode record",
"operationId": "DeleteClassCode",
"parameters": [
{
"name": "ClassCodeNo",
"in": "path",
"description": "The ClassCodeNo of the ClassCode to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ClassCode_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassCodes/{ClassCodeNo}/copy": {
"get": {
"tags": [
"ClassCodes"
],
"summary": "Copies an existing ClassCode to a new object",
"operationId": "CopyClassCode",
"parameters": [
{
"name": "ClassCodeNo",
"in": "path",
"description": "The ClassCodeNo of the ClassCode to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ClassCode object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ClassCode.ClassCode"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ClassCode_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassSocieties": {
"get": {
"tags": [
"ClassSocieties"
],
"summary": "Gets a list of ClassSocieties",
"operationId": "GetClassSocieties",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ClassSocieties"
],
"summary": "Creates a new classSociety record",
"operationId": "CreateClassSociety",
"requestBody": {
"description": "The ClassSociety Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ClassSociety_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassSocieties/{classSocietyNo}": {
"get": {
"tags": [
"ClassSocieties"
],
"summary": "Gets a specific ClassSociety",
"operationId": "GetClassSociety",
"parameters": [
{
"name": "classSocietyNo",
"in": "path",
"description": "The ClassSocietyNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested classSociety",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an classSociety with the supplied ClassSociety No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ClassSocieties"
],
"summary": "Updates an existing ClassSociety",
"operationId": "UpdateClassSociety",
"parameters": [
{
"name": "classSocietyNo",
"in": "path",
"description": "The ClassSocietyNo of the classSociety to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ClassSociety DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ClassSociety object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ClassSociety_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ClassSocieties"
],
"summary": "Deletes a classSociety record",
"parameters": [
{
"name": "classSocietyNo",
"in": "path",
"description": "The ClassSocietyNo of the ClassSociety to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ClassSociety_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassSocieties/{classSocietyNo}/history": {
"get": {
"tags": [
"ClassSocieties"
],
"summary": "Gets history for a specific ClassSociety",
"operationId": "GetClassSocietyHistory",
"parameters": [
{
"name": "classSocietyNo",
"in": "path",
"description": "The ClassSocietyNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested classSociety",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an classSociety with the supplied ClassSociety No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ClassSociety_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassSocieties/search": {
"post": {
"tags": [
"ClassSocieties"
],
"summary": "Search for ClassSocieties\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchClassSocieties",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested classSociety",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassSocieties/searchIndex/{classSocietyGuid}": {
"post": {
"tags": [
"ClassSocieties"
],
"summary": "Get index of a record in a search for classSocieties\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexClassSocieties",
"parameters": [
{
"name": "classSocietyGuid",
"in": "path",
"description": "The classSociety to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassSocieties/searchCount": {
"post": {
"tags": [
"ClassSocieties"
],
"summary": "Returns number of hits in a search for ClassSocieties\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountClassSocieties",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ClassSocieties/searchInfo": {
"get": {
"tags": [
"ClassSocieties"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoClassSocieties",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ClassSocieties/{classSocietyNo}/copy": {
"get": {
"tags": [
"ClassSocieties"
],
"summary": "Copies an existing ClassSociety to a new object",
"operationId": "CopyClassSociety",
"parameters": [
{
"name": "classSocietyNo",
"in": "path",
"description": "The ClassSocietyNo of the classSociety to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ClassSociety object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.ClassSociety"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ClassSociety_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CombinedUserRoles": {
"get": {
"tags": [
"CombinedUserRoles"
],
"summary": "Gets a list of userRoles",
"operationId": "GetCombinedUserRoles",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CombinedUserRoles/{userRoleNo}": {
"get": {
"tags": [
"CombinedUserRoles"
],
"summary": "Gets a specific userRole",
"operationId": "GetCombinedUserRole",
"parameters": [
{
"name": "userRoleNo",
"in": "path",
"description": "The UserNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested userRole",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a userRole with the supplied UserRole No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CombinedUserRoles/{userRoleNo}/history": {
"get": {
"tags": [
"CombinedUserRoles"
],
"summary": "Gets history for a specific User Role",
"operationId": "GetUserRoleHistory",
"parameters": [
{
"name": "userRoleNo",
"in": "path",
"description": "The UserRoleNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested userRole",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an userRole with the supplied UserRole No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CombinedUserRoles/search": {
"post": {
"tags": [
"CombinedUserRoles"
],
"summary": "Search for UserRoles\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchUserRoles",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CombinedUserRoles/searchCount": {
"post": {
"tags": [
"CombinedUserRoles"
],
"summary": "Returns number of hits in a search for UserRoles\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountUserRoles",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CombinedUserRoles/searchIndex/{userRoleGuid}": {
"post": {
"tags": [
"CombinedUserRoles"
],
"summary": "Get index of a record in a search for UserRoles\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexUserRoles",
"parameters": [
{
"name": "userRoleGuid",
"in": "path",
"description": "The userRole number to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CombinedUserRoles/searchInfo": {
"get": {
"tags": [
"CombinedUserRoles"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoUserRoles",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/CommunicationLanguages": {
"get": {
"tags": [
"CommunicationLanguages"
],
"summary": "Gets a list of CommunicationLanguages",
"operationId": "GetCommunicationLanguages",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CommunicationLanguage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"CommunicationLanguages"
],
"summary": "Creates a new communicationLanguage record",
"operationId": "CreateCommunicationLanguage",
"requestBody": {
"description": "The CommunicationLanguage Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CommunicationLanguage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CommunicationLanguages/{communicationLanguageNo}": {
"get": {
"tags": [
"CommunicationLanguages"
],
"summary": "Gets a specific CommunicationLanguage",
"operationId": "GetCommunicationLanguage",
"parameters": [
{
"name": "communicationLanguageNo",
"in": "path",
"description": "the communicationLanguageNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested communicationLanguage",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an communicationLanguage with the supplied CommunicationLanguage No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CommunicationLanguage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"CommunicationLanguages"
],
"summary": "Updates an existing CommunicationLanguage",
"operationId": "UpdateCommunicationLanguage",
"parameters": [
{
"name": "communicationLanguageNo",
"in": "path",
"description": "The communicationLanguageNo of the communicationLanguage to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The CommunicationLanguage DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated CommunicationLanguage object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CommunicationLanguage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"CommunicationLanguages"
],
"summary": "Deletes an communicationLanguage record",
"parameters": [
{
"name": "communicationLanguageNo",
"in": "path",
"description": "The communicationLanguageNo of the CommunicationLanguage to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CommunicationLanguage_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CommunicationLanguages/{communicationLanguageNo}/history": {
"get": {
"tags": [
"CommunicationLanguages"
],
"summary": "Gets history for a specific CommunicationLanguage",
"operationId": "GetCommunicationLanguageHistory",
"parameters": [
{
"name": "communicationLanguageNo",
"in": "path",
"description": "The communicationLanguageNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested communicationLanguage",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an communicationLanguage with the supplied CommunicationLanguage No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CommunicationLanguage_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CommunicationLanguages/search": {
"post": {
"tags": [
"CommunicationLanguages"
],
"summary": "Search for communicationLanguages\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCommunicationLanguages",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CommunicationLanguage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CommunicationLanguages/searchCount": {
"post": {
"tags": [
"CommunicationLanguages"
],
"summary": "Returns number of hits in a search for CommunicationLanguages\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCommunicationLanguages",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CommunicationLanguage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CommunicationLanguages/searchIndex/{communicationLanguageGuid}": {
"post": {
"tags": [
"CommunicationLanguages"
],
"summary": "Get index of a record in a search for CommunicationLanguages\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCommunicationLanguages",
"parameters": [
{
"name": "communicationLanguageGuid",
"in": "path",
"description": "The communicationLanguage to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CommunicationLanguage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CommunicationLanguages/searchInfo": {
"get": {
"tags": [
"CommunicationLanguages"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCommunicationLanguages",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/CommunicationLanguages/{communicationLanguageNo}/copy": {
"get": {
"tags": [
"CommunicationLanguages"
],
"summary": "Copies an existing communicationLanguage to a new object",
"operationId": "CopyCommunicationLanguage",
"parameters": [
{
"name": "communicationLanguageNo",
"in": "path",
"description": "The CommunicationLanguageNo of the communicationLanguage to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new CommunicationLanguage object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.CommunicationLanguage"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CommunicationLanguage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies": {
"get": {
"tags": [
"Companies"
],
"summary": "Gets a list of Companies",
"operationId": "GetCompanies",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Companies"
],
"summary": "Creates a new company record",
"operationId": "CreateCompany",
"requestBody": {
"description": "The Company Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Company_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/{companyNo}": {
"get": {
"tags": [
"Companies"
],
"summary": "Gets a specific Company",
"operationId": "GetCompany",
"parameters": [
{
"name": "companyNo",
"in": "path",
"description": "the companyNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested company",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an company with the supplied Company No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Companies"
],
"summary": "Updates an existing Company",
"operationId": "UpdateCompany",
"parameters": [
{
"name": "companyNo",
"in": "path",
"description": "The companyNo of the company to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Company DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Company object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Company_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Companies"
],
"summary": "Deletes an company record",
"parameters": [
{
"name": "companyNo",
"in": "path",
"description": "The companyNo of the Company to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Company_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/{companyNo}/history": {
"get": {
"tags": [
"Companies"
],
"summary": "Gets history for a specific Company",
"operationId": "GetCompanyHistory",
"parameters": [
{
"name": "companyNo",
"in": "path",
"description": "The companyNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested company",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an company with the supplied Company No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Company_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/search": {
"post": {
"tags": [
"Companies"
],
"summary": "Search for companies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCompanies",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/searchCount": {
"post": {
"tags": [
"Companies"
],
"summary": "Returns number of hits in a search for Companies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCompanies",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/searchIndex/{companyGuid}": {
"post": {
"tags": [
"Companies"
],
"summary": "Get index of a record in a search for Companies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCompanies",
"parameters": [
{
"name": "companyGuid",
"in": "path",
"description": "The company to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/searchInfo": {
"get": {
"tags": [
"Companies"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCompanies",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Companies/{companyNo}/copy": {
"get": {
"tags": [
"Companies"
],
"summary": "Copies an existing company to a new object",
"operationId": "CopyCompany",
"parameters": [
{
"name": "companyNo",
"in": "path",
"description": "The CompanyNo of the company to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Company object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.Company"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Company_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/{companyNo}/approvers": {
"get": {
"tags": [
"Companies"
],
"summary": "Returns a list of Approvers on the Company",
"operationId": "GetCompanyApprovers",
"parameters": [
{
"name": "companyNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyCombinedUserRole2"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyCombinedUserRole2"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyCombinedUserRole2"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/{companyNo}/approvers/{combinedUserRoleNo}/accounts": {
"get": {
"tags": [
"Companies"
],
"summary": "Returns a list of Accounts for the Approver on the Company",
"operationId": "GetCompanyApproverAccounts",
"parameters": [
{
"name": "companyNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "combinedUserRoleNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyCombinedUserRole2"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyCombinedUserRole2"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyCombinedUserRole2"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/{companyNo}/approvalSetupDimensions": {
"get": {
"tags": [
"Companies"
],
"summary": "Returns a list of Approval Setup Dimensions on the Company",
"operationId": "GetCompanyApprovalSetupDimensions",
"parameters": [
{
"name": "companyNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetupDimension"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetupDimension"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetupDimension"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/{companyNo}/approvalSetups": {
"get": {
"tags": [
"Companies"
],
"summary": "Returns a list of Approval Setups on the Company",
"operationId": "GetCompanyApprovalSetups",
"parameters": [
{
"name": "companyNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/{companyNo}/automaticReminders": {
"get": {
"tags": [
"Companies"
],
"summary": "Returns a list of Automatic Reminders on the Company",
"operationId": "GetCompanyAutomaticReminders",
"parameters": [
{
"name": "companyNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyAutomaticReminder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyAutomaticReminder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyAutomaticReminder"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementQA |
| MailAccountOnUnitCompany |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/{companyNo}/accountingDimensions": {
"get": {
"tags": [
"Companies"
],
"summary": "Returns a list of Accounting Dimensions on the Company",
"operationId": "GetCompanyAccountingDimensions",
"parameters": [
{
"name": "companyNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyAccountingDimension"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyAccountingDimension"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyAccountingDimension"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Companies/{companyNo}/approvalSetupAccountingDimensionRules": {
"get": {
"tags": [
"Companies"
],
"summary": "Returns a list of Approval Setup Accounting Dimension Rules on the Company",
"operationId": "GetCompanyApprovalSetupAccountingDimensionRules",
"parameters": [
{
"name": "companyNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetupAccountingDimensionRule"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetupAccountingDimensionRule"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetupAccountingDimensionRule"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentLocations": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "Gets a list of ComponentLocations",
"operationId": "GetComponentLocations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ComponentLocations"
],
"summary": "Creates a new componentLocation record",
"operationId": "CreateComponentLocation",
"requestBody": {
"description": "The ComponentLocation Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Location_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentLocations/{locationNo}": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "Gets a specific ComponentLocation",
"operationId": "GetComponentLocation",
"parameters": [
{
"name": "locationNo",
"in": "path",
"description": "The LocationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested componentLocation",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an componentLocation with the supplied ComponentLocation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ComponentLocations"
],
"summary": "Updates an existing ComponentLocation",
"operationId": "UpdateComponentLocation",
"parameters": [
{
"name": "locationNo",
"in": "path",
"description": "The LocationNo of the componentLocation to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ComponentLocation DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ComponentLocation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Location_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ComponentLocations"
],
"summary": "Deletes a componentLocation record",
"parameters": [
{
"name": "locationNo",
"in": "path",
"description": "The LocationNo of the ComponentLocation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Location_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentLocations/{locationNo}/history": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "Gets history for a specific ComponentLocation",
"operationId": "GetComponentLocationHistory",
"parameters": [
{
"name": "locationNo",
"in": "path",
"description": "The LocationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested componentLocation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an componentLocation with the supplied ComponentLocation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Location_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentLocations/search": {
"post": {
"tags": [
"ComponentLocations"
],
"summary": "Search for ComponentLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchComponentLocations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested componentLocation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentLocations/searchIndex/{locationGuid}": {
"post": {
"tags": [
"ComponentLocations"
],
"summary": "Get index of a record in a search for componentLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexComponentLocations",
"parameters": [
{
"name": "locationGuid",
"in": "path",
"description": "The componentLocation to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentLocations/searchCount": {
"post": {
"tags": [
"ComponentLocations"
],
"summary": "Returns number of hits in a search for ComponentLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountComponentLocations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentLocations/searchInfo": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoComponentLocations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ComponentLocations/{locationNo}/copy": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "Copies an existing ComponentLocation to a new object",
"operationId": "CopyComponentLocation",
"parameters": [
{
"name": "locationNo",
"in": "path",
"description": "The LocationNo of the componentLocation to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ComponentLocation object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentLocation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Location_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps": {
"get": {
"tags": [
"ComponentMaps"
],
"summary": "Gets a list of ComponentMaps",
"operationId": "GetComponentMaps",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ComponentMaps"
],
"summary": "Creates a new componentMap record",
"operationId": "CreateComponentMap",
"requestBody": {
"description": "The ComponentMap Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentMap_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/{componentMapNo}": {
"get": {
"tags": [
"ComponentMaps"
],
"summary": "Gets a specific ComponentMap",
"operationId": "GetComponentMap",
"parameters": [
{
"name": "componentMapNo",
"in": "path",
"description": "The ComponentMapNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested componentMap",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an componentMap with the supplied ComponentMap No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ComponentMaps"
],
"summary": "Updates an existing ComponentMap",
"operationId": "UpdateComponentMap",
"parameters": [
{
"name": "componentMapNo",
"in": "path",
"description": "The ComponentMapNo of the componentMap to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ComponentMap DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ComponentMap object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentMap_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ComponentMaps"
],
"summary": "Deletes a componentMap record",
"parameters": [
{
"name": "componentMapNo",
"in": "path",
"description": "The ComponentMapNo of the ComponentMap to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentMap_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/frontPage": {
"get": {
"tags": [
"ComponentMaps"
],
"summary": "Gets the Front Page ComponentMap for current Unit",
"operationId": "GetFrontPageComponentMap",
"responses": {
"200": {
"description": "Returns the requested componentMap",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"204": {
"description": "If a componentMap with the supplied ComponentMap No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/frontPage/exists": {
"get": {
"tags": [
"ComponentMaps"
],
"summary": "Gets a bool saying if a Front Page is set for current Unit",
"operationId": "HasFrontPageComponentMap",
"responses": {
"200": {
"description": "Returns the requested componentMap",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an componentMap with the supplied ComponentMap No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/{componentMapNo}/history": {
"get": {
"tags": [
"ComponentMaps"
],
"summary": "Gets history for a specific ComponentMap",
"operationId": "GetComponentMapHistory",
"parameters": [
{
"name": "componentMapNo",
"in": "path",
"description": "The ComponentMapNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested componentMap",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an componentMap with the supplied ComponentMap No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentMap_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/search": {
"post": {
"tags": [
"ComponentMaps"
],
"summary": "Search for ComponentMaps\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchComponentMaps",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested componentMap",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/searchIndex/{locationGuid}": {
"post": {
"tags": [
"ComponentMaps"
],
"summary": "Get index of a record in a search for componentMaps\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexComponentMaps",
"parameters": [
{
"name": "locationGuid",
"in": "path",
"description": "The componentMap to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/searchCount": {
"post": {
"tags": [
"ComponentMaps"
],
"summary": "Returns number of hits in a search for ComponentMaps\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountComponentMaps",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/searchInfo": {
"get": {
"tags": [
"ComponentMaps"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoComponentMaps",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ComponentMaps/{componentMapNo}/copy": {
"get": {
"tags": [
"ComponentMaps"
],
"summary": "Copies an existing ComponentMap to a new object",
"operationId": "CopyComponentMap",
"parameters": [
{
"name": "componentMapNo",
"in": "path",
"description": "The ComponentMapNo of the componentMap to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ComponentMap object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMap"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentMap_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/{componentMapNo}/hotspots": {
"get": {
"tags": [
"ComponentMaps"
],
"summary": "Fetches all Hotspots for the requested Component Map",
"operationId": "GetComponentMapHotspots",
"parameters": [
{
"name": "componentMapNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Component Map Hotspots for the requested Component Map",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMapHotspot"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMapHotspot"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMapHotspot"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/{componentMapNo}/overdueJobs": {
"get": {
"tags": [
"ComponentMaps"
],
"summary": "Fetches Number of overdue Jobs for each Hotspot on requested Component Map",
"operationId": "GetOverdueJobsForHotspots",
"parameters": [
{
"name": "componentMapNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Amount of overdue Jobs for each Hotspot on requested Component Map",
"content": {
"text/plain": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"description": "HotspotNo : Number of Overdue Jobs"
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"description": "HotspotNo : Number of Overdue Jobs"
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"description": "HotspotNo : Number of Overdue Jobs"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentMaps/{componentMapNo}/overdueJobs/{hotspotNo}": {
"get": {
"tags": [
"ComponentMaps"
],
"summary": "Fetches all Overdue Jobs for Hotspot",
"operationId": "GetOverdueJobsForHotspot",
"parameters": [
{
"name": "componentMapNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "hotspotNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the overdue Jobs for Hotspot",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMapHotspot"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMapHotspot"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMapHotspot"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos": {
"get": {
"tags": [
"ComponentPhotos"
],
"summary": "Gets a list of ComponentPhotos",
"operationId": "GetComponentPhotos",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ComponentPhotos"
],
"summary": "Creates a new document record",
"operationId": "CreateComponentPhoto",
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/{documentNo}": {
"get": {
"tags": [
"ComponentPhotos"
],
"summary": "Gets a specific ComponentPhoto",
"operationId": "GetComponentPhoto",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ComponentPhotos"
],
"summary": "Updates an existing Document",
"operationId": "UpdateComponentPhoto",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ComponentPhotos"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/searchIndex/{documentGuid}": {
"post": {
"tags": [
"ComponentPhotos"
],
"summary": "Get index of a record in a search for ComponentPhoto\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexComponentPhotos",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/{documentNo}/history": {
"get": {
"tags": [
"ComponentPhotos"
],
"summary": "Gets history for a specific ComponentPhoto",
"operationId": "GetComponentPhotoHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/search": {
"post": {
"tags": [
"ComponentPhotos"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchComponentPhotos",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/searchCount": {
"post": {
"tags": [
"ComponentPhotos"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountComponentPhotos",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/searchInfo": {
"get": {
"tags": [
"ComponentPhotos"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoComponentPhotos",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ComponentPhotos/{documentNo}/pdf": {
"get": {
"tags": [
"ComponentPhotos"
],
"summary": "",
"operationId": "GetComponentPhotoPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/{documentNo}/file": {
"get": {
"tags": [
"ComponentPhotos"
],
"summary": "",
"operationId": "GetComponentPhotoFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ComponentPhotos"
],
"operationId": "AddComponentPhotoFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "imageDimension",
"in": "query",
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
}
},
{
"name": "imageQuality",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 80
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"ComponentPhotos"
],
"summary": "Get document pdf from guid",
"operationId": "GetItemComponentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"ComponentPhotos"
],
"summary": "Get document file from guid",
"operationId": "GetComponentPhotoFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/{documentNo}/checkout": {
"put": {
"tags": [
"ComponentPhotos"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutComponentPhotoFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/{documentNo}/checkin": {
"post": {
"tags": [
"ComponentPhotos"
],
"summary": "",
"operationId": "CheckinComponentPhotoFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/{documentNo}/copy": {
"get": {
"tags": [
"ComponentPhotos"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyComponentPhoto",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentPhotos/{documentNo}/usage": {
"get": {
"tags": [
"ComponentPhotos"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetComponentPhotosUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components": {
"get": {
"tags": [
"Components"
],
"summary": "Gets a list of Components",
"operationId": "GetComponents",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Components"
],
"summary": "Creates a new component record",
"operationId": "CreateComponent",
"requestBody": {
"description": "The Component Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}": {
"get": {
"tags": [
"Components"
],
"summary": "Gets a specific Component",
"operationId": "GetComponent",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested component",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a component with the supplied Component No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Components"
],
"summary": "Updates an existing Component",
"operationId": "UpdateComponent",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo of the component to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Component DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Component object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Components"
],
"summary": "Deletes a component record",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo of the Component to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/history": {
"get": {
"tags": [
"Components"
],
"summary": "Gets history for a specific Component",
"operationId": "GetComponentHistory",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested component",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an component with the supplied Component No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/search": {
"post": {
"tags": [
"Components"
],
"summary": "Search for Components\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchComponents",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/searchCount": {
"post": {
"tags": [
"Components"
],
"summary": "Returns number of hits in a search for Components\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountComponents",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/searchIndex/{componentGuid}": {
"post": {
"tags": [
"Components"
],
"summary": "Get index of a record in a search for Components\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexComponents",
"parameters": [
{
"name": "componentGuid",
"in": "path",
"description": "The component to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/searchInfo": {
"get": {
"tags": [
"Components"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoComponents",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Components/{componentNo}/Items": {
"get": {
"tags": [
"Components"
],
"summary": "Returns a list of Items used to perform the Component",
"operationId": "GetComponentItems",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo to fetch items for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the component",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/force": {
"delete": {
"tags": [
"Components"
],
"summary": "Force deletes a component record\r\nForce deleting records may cause existing records to contain invalid data, that needs adjustment before they can be saved",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo of the Component to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/documents": {
"get": {
"tags": [
"Components"
],
"summary": "Returns a list of Documents used on the Component",
"operationId": "GetComponentDocuments",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The Componentno to fetch triggers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the triggers for the component",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/documents/{documentNo}": {
"get": {
"tags": [
"Components"
],
"summary": "Returns a specific component document",
"operationId": "GetComponentDocument",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The Componentno",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"description": "The no of the document to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the document for the component",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument"
}
}
}
},
"404": {
"description": "If a component document with the supplied document no cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/Suppliers": {
"get": {
"tags": [
"Components"
],
"summary": "Returns a list of Suppliers used for the Component",
"operationId": "GetComponentSuppliers",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo to fetch suppliers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the suppliers for the component",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/Suppliers/{supplierNo}": {
"get": {
"tags": [
"Components"
],
"summary": "Returns a specific Component Supplier",
"operationId": "GetComponentSupplier",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "supplierNo",
"in": "path",
"description": "The supplierNo to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the component",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier"
}
}
}
},
"404": {
"description": "If a component supplier with the supplied ComponentNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/counterhistories": {
"get": {
"tags": [
"Components"
],
"summary": "Returns a list of Counter Histories used on the Component",
"operationId": "GetCounterHistories",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The Component No to fetch counter histories for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the counter histories for the component",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/resetcounter": {
"post": {
"tags": [
"Components"
],
"summary": "Resets the counter on the Component to a specific value/date",
"operationId": "ResetComponentCounter",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The Component No to fetch counter histories for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The reading to reset to",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory"
}
}
}
},
"responses": {
"200": {
"description": "Returns the counter histories for the component",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AllowResetComponentCounter | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/copyCounterHistory": {
"post": {
"tags": [
"Components"
],
"summary": "Overwrites the counter history on a component with the history from the counter",
"operationId": "CopyCounterHistory",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The component no to have the counter history overwritten",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The counter history have been copied successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
},
"404": {
"description": "The component with the supplied component no could not be found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundResult"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/copy": {
"get": {
"tags": [
"Components"
],
"summary": "Copies an existing Component to a new object",
"operationId": "CopyComponent",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo of the Component to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Component object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/labels/{labelTemplateDocumentNo}": {
"post": {
"tags": [
"Components"
],
"summary": "Gets the labels to print",
"operationId": "PrintComponentLabels",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "the template No to print",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A Search Definition containing the component numbers to print",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested component report as pdf"
},
"404": {
"description": "If a component with the supplied Component No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/labels/{labelTemplateDocumentNo}/{settingsKey}": {
"get": {
"tags": [
"Components"
],
"summary": "Get the labels to print using ´settings key",
"operationId": "GetLabelPdf",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "The template No to print",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "settingsKey",
"in": "path",
"description": "The UUID for the stored search definition",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/disable": {
"post": {
"tags": [
"Components"
],
"summary": "Disable the component",
"operationId": "DisableComponent",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "disables the requested component"
},
"404": {
"description": "If a component with the supplied Component No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_AllowDisableComponent | AllowDisableComponent |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/enable": {
"post": {
"tags": [
"Components"
],
"summary": "Enable the component",
"operationId": "EnableComponent",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "enables the requested component"
},
"404": {
"description": "If a component with the supplied Component No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_AllowDisableComponent | AllowDisableComponent |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/propertyDefinitions": {
"get": {
"tags": [
"Components"
],
"summary": "Get a list of PropertyDefinitions",
"operationId": "GetPropertyDefinitions",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Components"
],
"summary": "Creates a new PropertyDefinition record",
"operationId": "CreatePropertyDefinition",
"requestBody": {
"description": "The PropertyDefinition DTO object to create",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/propertyDefinitions/{propertyDefinitionGuid}": {
"get": {
"tags": [
"Components"
],
"summary": "Gets a specific PropertyDefinition",
"operationId": "GetPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested PropertyDefinition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an GetPropertyDefinition with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Components"
],
"summary": "Updates an existing PropertyDefinition",
"operationId": "UpdatePropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The PropertyDefinition DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PropertyDefinition object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Components"
],
"summary": "Deletes a PropertyDefinition record",
"operationId": "DeletePropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/propertyDefinitions/{propertyDefinitionGuid}/listValues": {
"get": {
"tags": [
"Components"
],
"summary": "Returns a list of values for a PropertyDefinition",
"operationId": "GetComponentPropertyDefinitionListValues",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The PropertyDefinition Guid to fetch values for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "textFilter",
"in": "query",
"description": "(optional) text filter",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the values for the ListOfValuesTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/propertyDefinitions/{propertyDefinitionGuid}/force": {
"delete": {
"tags": [
"Components"
],
"summary": "Force Deletes a PropertyDefinition record",
"operationId": "ForceDeletePropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/propertyDefinitions/{propertyName}/available": {
"get": {
"tags": [
"Components"
],
"summary": "Lookup if PropertyName of a PropertyDefinition is not already in use and therefore available to be used",
"operationId": "ComponentPropertyNameAvailable",
"parameters": [
{
"name": "propertyName",
"in": "path",
"description": "The propertyName to check",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns true is property name is available to be used",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/shipdex": {
"get": {
"tags": [
"Components"
],
"summary": "Exports the chosen component and its data as Shipdex data.",
"operationId": "GetShipdexFile",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The Component No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "If a component with the supplied Component No cannot be found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "If a component cannot be converted to Shipdex",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested components Shipdex data as a zip"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/shipdex": {
"get": {
"tags": [
"Components"
],
"summary": "Checks if the current Shipdex setup is valid.",
"operationId": "ValidateShipdexSetup",
"responses": {
"200": {
"description": "Returns a validation result",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "If Shipdex setup is invalid",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/screenLayout": {
"post": {
"tags": [
"Components"
],
"summary": "Bulk updates screenlayout and a list of Property Definitions. The endpoint handles whether or not to create or update each record in the requst.",
"operationId": "BulkUpdateScreenLayout",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/appSubmit": {
"post": {
"tags": [
"Components"
],
"operationId": "ReceiveComponent",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.ComponentAppObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.ComponentAppObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.ComponentAppObject"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.ComponentAppObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/responses": {
"get": {
"tags": [
"Components"
],
"summary": "Gets a list of component responses",
"operationId": "GetComponentResponses",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The component no. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/responses/count": {
"get": {
"tags": [
"Components"
],
"summary": "Returns number of ComponentResponses for ComponentNo",
"operationId": "CountComponentResponses",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/addResponse": {
"post": {
"tags": [
"Components"
],
"summary": "Add response",
"operationId": "AddComponentResponse",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "The ComponentNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ComponentResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/webhooklogs/search": {
"post": {
"tags": [
"Components"
],
"summary": "Searches the Webhooks associated with the Component.",
"operationId": "SearchComponentWebhookLogs",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| WebhooksIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/webhooklogs/searchCount": {
"post": {
"tags": [
"Components"
],
"summary": "Returns number of hits in a search for the Component's Webhook Logs.\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchComponentWebhookLogsCount",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/webhooklogs/{webhookLogGuid}/retransmit": {
"post": {
"tags": [
"Components"
],
"summary": "Retransmits a specific Webhook based on the selected Webhook Log.",
"operationId": "RetransmitComponentWebhookLog",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookLogGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/webhooklogs/{webhookLogGuid}/resolve": {
"post": {
"tags": [
"Components"
],
"summary": "Resolves a specific Webhook Log with a Response Log entry.",
"operationId": "ResolveComponentWebhookLog",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookLogGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/{componentNo}/rotate": {
"post": {
"tags": [
"Components"
],
"summary": "Rotates two components",
"operationId": "RotateComponent",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentRotateArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentRotateArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentRotateArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentRotateArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_AllowRotateComponent | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/BatchEdit": {
"post": {
"tags": [
"Components"
],
"operationId": "ComponentBatchEdit",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEdit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEdit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEdit"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEdit"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Components/BatchEdit/ApplyTransformations/{componentNo}": {
"post": {
"tags": [
"Components"
],
"operationId": "ComponentBatchEditApplyTransformations",
"parameters": [
{
"name": "componentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Component_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentTypes": {
"get": {
"tags": [
"ComponentTypes"
],
"summary": "Gets a list of ComponentTypes",
"operationId": "GetComponentTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ComponentTypes"
],
"summary": "Creates a new componentType record",
"operationId": "CreateComponentType",
"requestBody": {
"description": "The ComponentType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentTypes/{typeNo}": {
"get": {
"tags": [
"ComponentTypes"
],
"summary": "Gets a specific ComponentType",
"operationId": "GetComponentType",
"parameters": [
{
"name": "typeNo",
"in": "path",
"description": "The TypeNo of the ComponentType to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested componentTypeType"
},
"400": {
"description": "Returns a validation result with information about the bad request"
},
"404": {
"description": "If a componentType with the supplied Component No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentTypes/{TypeNo}/history": {
"get": {
"tags": [
"ComponentTypes"
],
"summary": "Gets history for a specific ComponentType",
"operationId": "GetComponentTypeHistory",
"parameters": [
{
"name": "typeNo",
"in": "path",
"description": "The ComponentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested componentType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an componentType with the supplied Component No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentTypes/search": {
"post": {
"tags": [
"ComponentTypes"
],
"summary": "Search for ComponentTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchComponentTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentTypes/searchCount": {
"post": {
"tags": [
"ComponentTypes"
],
"summary": "Returns number of hits in a search for ComponentTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountComponentTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentTypes/searchIndex/{componentTypeGuid}": {
"post": {
"tags": [
"ComponentTypes"
],
"summary": "Get index of a record in a search for ComponentTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexComponentTypes",
"parameters": [
{
"name": "componentTypeGuid",
"in": "path",
"description": "The componentType to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentTypes/searchInfo": {
"get": {
"tags": [
"ComponentTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoComponentTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ComponentTypes/{TypeNo}": {
"put": {
"tags": [
"ComponentTypes"
],
"summary": "Updates an existing ComponentType",
"operationId": "UpdateComponentType",
"parameters": [
{
"name": "TypeNo",
"in": "path",
"description": "The ComponentTypeNo of the componentType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ComponentType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ComponentType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ComponentTypes"
],
"summary": "Deletes a componentType record",
"parameters": [
{
"name": "TypeNo",
"in": "path",
"description": "The ComponentTypeNo of the ComponentType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ComponentTypes/{TypeNo}/copy": {
"get": {
"tags": [
"ComponentTypes"
],
"summary": "Copies an existing ComponentType to a new object",
"operationId": "CopyComponentType",
"parameters": [
{
"name": "TypeNo",
"in": "path",
"description": "The ComponentTypeNo of the ComponentType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ComponentType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ComponentType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopies": {
"get": {
"tags": [
"ControlledCopies"
],
"summary": "Gets a list of ControlledCopies",
"operationId": "GetControlledCopies",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ControlledCopies"
],
"summary": "Creates a new controlledCopy record",
"operationId": "CreateControlledCopy",
"requestBody": {
"description": "The ControlledCopy Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopies/{copyNo}": {
"get": {
"tags": [
"ControlledCopies"
],
"summary": "Gets a specific ControlledCopy",
"operationId": "GetControlledCopy",
"parameters": [
{
"name": "copyNo",
"in": "path",
"description": "the copyNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested controlledCopy",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an controlledCopy with the supplied ControlledCopy No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ControlledCopies"
],
"summary": "Updates an existing ControlledCopy",
"operationId": "UpdateControlledCopy",
"parameters": [
{
"name": "copyNo",
"in": "path",
"description": "The copyNo of the controlledCopy to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ControlledCopy DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ControlledCopy object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ControlledCopies"
],
"summary": "Deletes an controlledCopy record",
"parameters": [
{
"name": "copyNo",
"in": "path",
"description": "The copyNo of the ControlledCopy to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopies/{copyNo}/history": {
"get": {
"tags": [
"ControlledCopies"
],
"summary": "Gets history for a specific ControlledCopy",
"operationId": "GetControlledCopyHistory",
"parameters": [
{
"name": "copyNo",
"in": "path",
"description": "The copyNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested controlledCopy",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an controlledCopy with the supplied ControlledCopy No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopies/search": {
"post": {
"tags": [
"ControlledCopies"
],
"summary": "Search for controlledCopies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchControlledCopies",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopies/searchCount": {
"post": {
"tags": [
"ControlledCopies"
],
"summary": "Returns number of hits in a search for ControlledCopies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountControlledCopies",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopies/searchIndex/{controlledCopyGuid}": {
"post": {
"tags": [
"ControlledCopies"
],
"summary": "Get index of a record in a search for ControlledCopies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexControlledCopies",
"parameters": [
{
"name": "controlledCopyGuid",
"in": "path",
"description": "The controlledCopy to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopies/searchInfo": {
"get": {
"tags": [
"ControlledCopies"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoControlledCopies",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ControlledCopies/{copyNo}/copy": {
"get": {
"tags": [
"ControlledCopies"
],
"summary": "Copies an existing controlledCopy to a new object",
"operationId": "CopyControlledCopy",
"parameters": [
{
"name": "copyNo",
"in": "path",
"description": "The copyNo of the controlledCopy to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ControlledCopy object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopy"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopies/{copyNo}/email": {
"post": {
"tags": [
"ControlledCopies"
],
"summary": "Send the controlled copy as an email to the assigned User or Role.",
"operationId": "EmailControlledCopy",
"parameters": [
{
"name": "copyNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopies/{copyNo}/revisionhistory": {
"get": {
"tags": [
"ControlledCopies"
],
"operationId": "GetControlledCopyRevisionHistory",
"parameters": [
{
"name": "copyNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopyRevision"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopyRevision"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopyRevision"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopies/{copyNo}/controlledCopySection": {
"get": {
"tags": [
"ControlledCopies"
],
"operationId": "GetControlledCopySection",
"parameters": [
{
"name": "copyNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopySection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopySection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopySection"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ControlledCopy | View |
Customer must have one of these License values set| Key | Right |
|---|
| ManagementSystemWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments": {
"get": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Gets a list of ControlledCopyRevisionDocuments",
"operationId": "GetControlledCopyRevisionDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateControlledCopyRevisionDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/{documentNo}": {
"get": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Gets a specific ControlledCopyRevisionDocument",
"operationId": "GetControlledCopyRevisionDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Updates an existing Document",
"operationId": "UpdateControlledCopyRevisionDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Get index of a record in a search for ControlledCopyRevisionDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexControlledCopyRevisionDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/{documentNo}/history": {
"get": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Gets history for a specific ControlledCopyRevisionDocument",
"operationId": "GetControlledCopyRevisionDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/search": {
"post": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchControlledCopyRevisionDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/searchCount": {
"post": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountControlledCopyRevisionDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/searchInfo": {
"get": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoControlledCopyRevisionDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ControlledCopyRevisionDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "",
"operationId": "GetControlledCopyRevisionDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/{documentNo}/file": {
"get": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "",
"operationId": "GetControlledCopyRevisionDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"operationId": "AddControlledCopyRevisionDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetControlledCopyRevisionDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetControlledCopyRevisionDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/{documentNo}/checkout": {
"put": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutControlledCopyRevisionDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ControlledCopyRevisionDocuments/{documentNo}/checkin": {
"post": {
"tags": [
"ControlledCopyRevisionDocuments"
],
"summary": "",
"operationId": "CheckinControlledCopyRevisionDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters": {
"get": {
"tags": [
"Counters"
],
"summary": "Gets a list of Counters",
"operationId": "GetCounters",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Counters"
],
"summary": "Creates a new counter record",
"operationId": "CreateCounter",
"requestBody": {
"description": "The Counter Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Counter_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/{counterNo}": {
"get": {
"tags": [
"Counters"
],
"summary": "Gets a specific Counter",
"operationId": "GetCounter",
"parameters": [
{
"name": "counterNo",
"in": "path",
"description": "The CounterNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested counter",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an counter with the supplied Counter No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Counters"
],
"summary": "Updates an existing Counter",
"operationId": "UpdateCounter",
"parameters": [
{
"name": "counterNo",
"in": "path",
"description": "The CounterNo of the counter to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Counter DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Counter object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Counter_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Counters"
],
"summary": "Deletes a counter record",
"parameters": [
{
"name": "counterNo",
"in": "path",
"description": "The CounterNo of the Counter to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Counter_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/{counterNo}/history": {
"get": {
"tags": [
"Counters"
],
"summary": "Gets history for a specific Counter",
"operationId": "GetCounterHistory",
"parameters": [
{
"name": "counterNo",
"in": "path",
"description": "The CounterNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested counter",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an counter with the supplied Counter No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Counter_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/search": {
"post": {
"tags": [
"Counters"
],
"summary": "Search for Counters\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCounters",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/searchIndex/{counterGuid}": {
"post": {
"tags": [
"Counters"
],
"summary": "Get index of a record in a search for counters\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCounters",
"parameters": [
{
"name": "counterGuid",
"in": "path",
"description": "The counter to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/searchCount": {
"post": {
"tags": [
"Counters"
],
"summary": "Returns number of hits in a search for Counters\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCounters",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/searchInfo": {
"get": {
"tags": [
"Counters"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCounters",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Counters/{counterNo}/force": {
"delete": {
"tags": [
"Counters"
],
"summary": "Force deletes a counter record\r\nForce deleting records may cause existing records to contain invalid data, that needs adjustment before they can be saved",
"parameters": [
{
"name": "counterNo",
"in": "path",
"description": "The CounterNo of the Counter to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Counter_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/{counterNo}/readings": {
"get": {
"tags": [
"Counters"
],
"summary": "Returns a list of Histories used on the Counter",
"operationId": "GetReadings",
"parameters": [
{
"name": "counterNo",
"in": "path",
"description": "The Counter No to fetch counter histories for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the counter histories for the counter",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Counters"
],
"summary": "Performs a new Counter Reading for the given counter\r\nWill update both related Components and recalculate job triggers",
"operationId": "AddCounterReading",
"parameters": [
{
"name": "counterNo",
"in": "path",
"description": "The Counter No to fetch counter histories for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The counterhistory to add",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
}
}
},
"responses": {
"200": {
"description": "The counter reading is created and succesfull"
},
"400": {
"description": "A validation result is returned with the reasons why counter reading was not accepted",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Counter_Update | Update |
| AllowEnterCounterValue | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/{counterNo}/readings/force": {
"post": {
"tags": [
"Counters"
],
"summary": "Performs a new Counter Reading for the given counter\r\nWill update both related Components and recalculate job triggers",
"operationId": "ForceAddCounterReading",
"parameters": [
{
"name": "counterNo",
"in": "path",
"description": "The Counter No to fetch counter histories for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The counterhistory to add",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
}
}
},
"responses": {
"200": {
"description": "The counter reading is created and succesfull"
},
"400": {
"description": "A validation result is returned with the reasons why counter reading was not accepted",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Counter_Update | Update |
| AllowEnterCounterValue | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/{counterNo}/readings/graph/{daysToCover}": {
"get": {
"tags": [
"Counters"
],
"summary": "Returns a list of Histories used on the Counter prepared for graph",
"operationId": "GetReadingsGraphData",
"parameters": [
{
"name": "counterNo",
"in": "path",
"description": "The Counter No to fetch counter histories for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "daysToCover",
"in": "path",
"description": "How many days the graph should cover",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Returns the counter histories for the counter",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.CounterHistoryGraphData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.CounterHistoryGraphData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.CounterHistoryGraphData"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/{counterNo}/copy": {
"get": {
"tags": [
"Counters"
],
"summary": "Copies an existing Counter to a new object",
"operationId": "CopCounter",
"parameters": [
{
"name": "counterNo",
"in": "path",
"description": "The CounterNo of the Counter to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Counter object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.Counter"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Counter_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/labels/{documentNo}": {
"post": {
"tags": [
"Counters"
],
"summary": "Gets the labels to print",
"operationId": "PrintCounterLabels",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "the template No to print",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A Search Definition containing the counter numbers to print",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested counter report as pdf"
},
"404": {
"description": "If a counter with the supplied Counter No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/labels/{labelTemplateDocumentNo}/{settingsKey}": {
"get": {
"tags": [
"Counters"
],
"summary": "Get the labels to print using ´settings key",
"operationId": "GetCounterLabelPdf",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "The template No to print",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "settingsKey",
"in": "path",
"description": "The UUID for the stored search definition",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Counters/appSubmit": {
"post": {
"tags": [
"Counters"
],
"summary": "Receive new Counter History from new Job App",
"operationId": "ReceiveCounterHistory",
"requestBody": {
"description": "The counterhistory to add",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Counter_Update | Update |
| AllowEnterCounterValue | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CounterTypes": {
"get": {
"tags": [
"CounterTypes"
],
"summary": "Gets a list of CounterTypes",
"operationId": "GetCounterTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"CounterTypes"
],
"summary": "Creates a new counterType record",
"operationId": "CreateCounterType",
"requestBody": {
"description": "The CounterType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CounterType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CounterTypes/{counterTypeNo}": {
"get": {
"tags": [
"CounterTypes"
],
"summary": "Gets a specific CounterType",
"operationId": "GetCounterType",
"parameters": [
{
"name": "counterTypeNo",
"in": "path",
"description": "The CounterTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested counterType",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an counterType with the supplied CounterType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"CounterTypes"
],
"summary": "Updates an existing CounterType",
"operationId": "UpdateCounterType",
"parameters": [
{
"name": "counterTypeNo",
"in": "path",
"description": "The CounterTypeNo of the counterType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The CounterType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated CounterType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CounterType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"CounterTypes"
],
"summary": "Deletes a counterType record",
"parameters": [
{
"name": "counterTypeNo",
"in": "path",
"description": "The CounterTypeNo of the CounterType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CounterType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CounterTypes/{counterTypeNo}/history": {
"get": {
"tags": [
"CounterTypes"
],
"summary": "Gets history for a specific CounterType",
"operationId": "GetCounterTypeHistory",
"parameters": [
{
"name": "counterTypeNo",
"in": "path",
"description": "The CounterTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested counterType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an counterType with the supplied CounterType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CounterType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CounterTypes/search": {
"post": {
"tags": [
"CounterTypes"
],
"summary": "Search for CounterTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCounterTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CounterTypes/searchIndex/{counterTypeGuid}": {
"post": {
"tags": [
"CounterTypes"
],
"summary": "Get index of a record in a search for countertype\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCounterTypes",
"parameters": [
{
"name": "counterTypeGuid",
"in": "path",
"description": "The countertype to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CounterTypes/searchCount": {
"post": {
"tags": [
"CounterTypes"
],
"summary": "Returns number of hits in a search for CounterTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCounterTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CounterTypes/searchInfo": {
"get": {
"tags": [
"CounterTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCounterTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/CounterTypes/{counterTypeNo}/copy": {
"get": {
"tags": [
"CounterTypes"
],
"summary": "Copies an existing counterType to a new object",
"operationId": "CopyCounterType",
"parameters": [
{
"name": "counterTypeNo",
"in": "path",
"description": "The CounterTypeNo of the CounterType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new CounterType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CounterType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CountryCodes": {
"get": {
"tags": [
"CountryCodes"
],
"summary": "Gets a list of CountryCodes",
"operationId": "GetCountryCodes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"CountryCodes"
],
"summary": "Creates a new countryCode record",
"operationId": "CreateCountryCode",
"requestBody": {
"description": "The CountryCode Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CountryCode_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CountryCodes/{countryCodeNo}": {
"get": {
"tags": [
"CountryCodes"
],
"summary": "Gets a specific CountryCode",
"operationId": "GetCountryCode",
"parameters": [
{
"name": "countryCodeNo",
"in": "path",
"description": "the countryCodeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested countryCode",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an countryCode with the supplied CountryCode No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"CountryCodes"
],
"summary": "Updates an existing CountryCode",
"operationId": "UpdateCountryCode",
"parameters": [
{
"name": "countryCodeNo",
"in": "path",
"description": "The countryCodeNo of the countryCode to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The CountryCode DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated CountryCode object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CountryCode_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"CountryCodes"
],
"summary": "Deletes an countryCode record",
"parameters": [
{
"name": "countryCodeNo",
"in": "path",
"description": "The countryCodeNo of the CountryCode to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CountryCode_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CountryCodes/{countryCodeNo}/history": {
"get": {
"tags": [
"CountryCodes"
],
"summary": "Gets history for a specific CountryCode",
"operationId": "GetCountryCodeHistory",
"parameters": [
{
"name": "countryCodeNo",
"in": "path",
"description": "The countryCodeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested countryCode",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an countryCode with the supplied CountryCode No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CountryCode_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CountryCodes/search": {
"post": {
"tags": [
"CountryCodes"
],
"summary": "Search for countryCodes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountryCodes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CountryCodes/searchCount": {
"post": {
"tags": [
"CountryCodes"
],
"summary": "Returns number of hits in a search for CountryCodes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCountryCodes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CountryCodes/searchIndex/{countryCodeGuid}": {
"post": {
"tags": [
"CountryCodes"
],
"summary": "Get index of a record in a search for CountryCodes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCountryCodes",
"parameters": [
{
"name": "countryCodeGuid",
"in": "path",
"description": "The countryCode to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/CountryCodes/searchInfo": {
"get": {
"tags": [
"CountryCodes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCountryCodes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/CountryCodes/{countryCodeNo}/copy": {
"get": {
"tags": [
"CountryCodes"
],
"summary": "Copies an existing countryCode to a new object",
"operationId": "CopyCountryCode",
"parameters": [
{
"name": "countryCodeNo",
"in": "path",
"description": "The CountryCodeNo of the countryCode to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new CountryCode object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CountryCode.CountryCode"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| CountryCode_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Currencies": {
"get": {
"tags": [
"Currencies"
],
"summary": "Gets a list of Currencies",
"operationId": "GetCurrencies",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Currencies"
],
"summary": "Creates a new currency record",
"operationId": "CreateCurrency",
"requestBody": {
"description": "The Currency Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Currency_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Currencies/{currencyNo}": {
"get": {
"tags": [
"Currencies"
],
"summary": "Gets a specific Currency",
"operationId": "GetCurrency",
"parameters": [
{
"name": "currencyNo",
"in": "path",
"description": "the currencyNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested currency",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an currency with the supplied Currency No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Currencies"
],
"summary": "Updates an existing Currency",
"operationId": "UpdateCurrency",
"parameters": [
{
"name": "currencyNo",
"in": "path",
"description": "The currencyNo of the currency to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Currency DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Currency object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Currency_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Currencies"
],
"summary": "Deletes an currency record",
"parameters": [
{
"name": "currencyNo",
"in": "path",
"description": "The currencyNo of the Currency to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Currency_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Currencies/{currencyNo}/history": {
"get": {
"tags": [
"Currencies"
],
"summary": "Gets history for a specific Currency",
"operationId": "GetCurrencyHistory",
"parameters": [
{
"name": "currencyNo",
"in": "path",
"description": "The currencyNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested currency",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an currency with the supplied Currency No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Currency_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Currencies/search": {
"post": {
"tags": [
"Currencies"
],
"summary": "Search for currencies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCurrencies",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Currencies/searchCount": {
"post": {
"tags": [
"Currencies"
],
"summary": "Returns number of hits in a search for Currencies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountCurrencies",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Currencies/searchIndex/{currencyGuid}": {
"post": {
"tags": [
"Currencies"
],
"summary": "Get index of a record in a search for Currencies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexCurrencies",
"parameters": [
{
"name": "currencyGuid",
"in": "path",
"description": "The currency to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Currencies/searchInfo": {
"get": {
"tags": [
"Currencies"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoCurrencies",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Currencies/{currencyNo}/copy": {
"get": {
"tags": [
"Currencies"
],
"summary": "Copies an existing currency to a new object",
"operationId": "CopyCurrency",
"parameters": [
{
"name": "currencyNo",
"in": "path",
"description": "The CurrencyNo of the currency to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Currency object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.Currency"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Currency_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Currencies/{currencyNo}/rates": {
"get": {
"tags": [
"Currencies"
],
"summary": "Returns a list of Currncy Rates for a specific Currency",
"operationId": "GetRates",
"parameters": [
{
"name": "currencyNo",
"in": "path",
"description": "The Currency No to fetch items for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Currency Rates for the Currency",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.CurrencyRate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.CurrencyRate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.CurrencyRate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataTransactions/search": {
"post": {
"tags": [
"DataTransactions"
],
"summary": "Search for DataTransactions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDataTransactions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.DataTransaction"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.DataTransaction"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.DataTransaction"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataTransaction | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataTransactions/searchInfo": {
"get": {
"tags": [
"DataTransactions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDataTransactions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DataTransactions/searchCount": {
"post": {
"tags": [
"DataTransactions"
],
"summary": "Returns number \r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDataTransactions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataTransaction | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataTransactions/searchIndex/{dataTransactionGuid}": {
"post": {
"tags": [
"DataTransactions"
],
"summary": "Get index of a record in a search for Data Transactions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDataTransactionIndex",
"parameters": [
{
"name": "dataTransactionGuid",
"in": "path",
"description": "The data transaction to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataTransaction | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataTransactions/Outgoing/{dataTransactionNo}/retransmit": {
"post": {
"tags": [
"DataTransactions"
],
"summary": "Mark Data Transaction for Retransmission",
"operationId": "RetransmitDataTransaction",
"parameters": [
{
"name": "dataTransactionNo",
"in": "path",
"description": "DataTransactionNo",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataTransaction_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataTransactions/{direction}/{dataTransactionNo}/Data": {
"get": {
"tags": [
"DataTransactions"
],
"summary": "Returns a list of DataTransactionData used for the DataTransactions",
"operationId": "GetDataTransactionData",
"parameters": [
{
"name": "dataTransactionNo",
"in": "path",
"description": "The DataTransactionNo to fetch data for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "direction",
"in": "path",
"description": "The direction of the DataTransaction to fetch data for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Transaction Data for the Data Transaction",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.DataTransactionData"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.DataTransactionData"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.DataTransactionData"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataTransaction | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates": {
"get": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Gets a list of DataWarehouseAnalyticsTemplate",
"operationId": "GetDataWarehouseAnalyticsTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Creates a new DataWarehouseAnalyticsTemplate record",
"operationId": "CreateDataWarehouseTemplate",
"requestBody": {
"description": "The DataWarehouseAnalyticsTemplate Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/{templateNo}": {
"get": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Gets a specific DataWarehouseAnalyticsTemplate",
"operationId": "GetDataWarehouseAnalyticsTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "the templateNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested DataWarehouseAnalyticsTemplate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an DataWarehouseAnalyticsTemplate with the supplied DataWarehouseAnalyticsTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Updates an existing DataWarehouseAnalyticsTemplate",
"operationId": "UpdateDataWarehouseAnalyticsTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "The templateNo of the DataWarehouseAnalyticsTemplate to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The DataWarehouseAnalyticsTemplate DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated DataWarehouseTemplate object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Deletes an DataWarehouseAnalyticsTemplate record",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "The templateNo of the DataWarehouseAnalyticsTemplate to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/{templateNo}/history": {
"get": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Gets history for a specific DataWarehouseAnalyticsTemplate",
"operationId": "GetDataWarehouseAnalyticsTemplateHistory",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "The templateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested DataWarehouseAnalyticsTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an DataWarehouseAnalyticsTemplate with the supplied DataWarehouseAnalyticsTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/search": {
"post": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Search for DataWarehouseAnalyticsTemplate\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDataWarehouseAnalyticsTemplate",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/searchCount": {
"post": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Returns number of hits in a search for DataWarehouseAnalyticsTemplate\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDataWarehouseAnalyticsTemplate",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/searchIndex/{DataWarehouseTemplateGuid}": {
"post": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Get index of a record in a search for DataWarehouseAnalyticsTemplate\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDataWarehouseTemplate",
"parameters": [
{
"name": "dataWarehouseAnalyticsTemplateGuid",
"in": "query",
"description": "The DataWarehouseAnalyticsTemplate to get index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "DataWarehouseTemplateGuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/searchInfo": {
"get": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDataWarehouseAnalyticsTemplate",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DataWarehouseAnalyticsTemplates/{templateNo}/copy": {
"get": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Copies an existing DataWarehouseAnalyticsTemplate to a new object",
"operationId": "CopyDataWarehouseAnalyticsTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "The templateNo of the DataWarehouseAnalyticsTemplateto copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new DataWarehouseAnalyticsTemplate object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/{templateNo}/unlock": {
"post": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Unlock the DataWarehouse analytics Template",
"operationId": "UnlockDataWarehouseAnalyticsTemplate",
"parameters": [
{
"name": "templateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Returns no content if the template is unlocked"
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/{templateNo}/tasks": {
"get": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Get all DataWarehouse Analytics Template TS Tasks.",
"operationId": "GetDataWarehouseAnalyticsTemplateTsTasks",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateTsTask"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateTsTask"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateTsTask"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/{templateNo}/tasks/{taskNo}": {
"get": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Get a DataWarehouse Analytics Template TS Task.",
"operationId": "GetDataWarehouseAnalyticsTemplateTsTask",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "taskNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateTsTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateTsTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateTsTask"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/{templateNo}/export": {
"post": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Creates a system task to export the Data Warehouse Template to the Data Warehouse.",
"operationId": "ExportToDataWarehouse",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate_Export | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/{templateNo}/resources": {
"get": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Fetches all Resources attached to the Data Warehouse Template",
"operationId": "GetDataWarehouseAnalyticsTemplateResources",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateResource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseAnalyticsTemplates/{templateNo}/roles": {
"get": {
"tags": [
"DataWarehouseAnalyticsTemplates"
],
"summary": "Fetches all Roles attached to the Data Warehouse Template",
"operationId": "GetDataWarehouseAnalyticsTemplateRoles",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateRole"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateRole"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateRole"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseConnections": {
"get": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Gets a list of DataWarehouseConnection",
"operationId": "GetDataWarehouseConnections",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Creates a new dataWarehouseConnection record",
"operationId": "CreateDataWarehouseConnection",
"requestBody": {
"description": "The DataWarehouseConnection Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseConnections/{connectionNo}": {
"get": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Gets a specific DataWarehouseConnection",
"operationId": "GetDataWarehouseConnection",
"parameters": [
{
"name": "connectionNo",
"in": "path",
"description": "the connectionNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested dataWarehouseConnection",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an dataWarehouseConnection with the supplied DataWarehouseConnection No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Updates an existing DataWarehouseConnection",
"operationId": "UpdateDataWarehouseConnection",
"parameters": [
{
"name": "connectionNo",
"in": "path",
"description": "The connectionNo of the dataWarehouseConnection to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The DataWarehouseConnection DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated DataWarehouseConnection object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Deletes an dataWarehouseConnection record",
"parameters": [
{
"name": "connectionNo",
"in": "path",
"description": "The connectionNo of the DataWarehouseConnection to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseConnections/{connectionNo}/history": {
"get": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Gets history for a specific DataWarehouseConnection",
"operationId": "GetDataWarehouseConnectionHistory",
"parameters": [
{
"name": "connectionNo",
"in": "path",
"description": "The connectionNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested dataWarehouseConnection",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an dataWarehouseConnection with the supplied DataWarehouseConnection No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseConnections/search": {
"post": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Search for dataWarehouseConnection\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDataWarehouseConnection",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseConnections/searchCount": {
"post": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Returns number of hits in a search for DataWarehouseConnection\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDataWarehouseConnection",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseConnections/searchIndex/{dataWarehouseConnectionGuid}": {
"post": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Get index of a record in a search for DataWarehouseConnection\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDataWarehouseConnection",
"parameters": [
{
"name": "dataWarehouseConnectionGuid",
"in": "path",
"description": "The dataWarehouseConnection to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseConnections/searchInfo": {
"get": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDataWarehouseConnection",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DataWarehouseConnections/{connectionNo}/copy": {
"get": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Copies an existing dataWarehouseConnection to a new object",
"operationId": "CopyDataWarehouseConnection",
"parameters": [
{
"name": "connectionNo",
"in": "path",
"description": "The ConnectionNo of the dataWarehouseConnection to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new DataWarehouseConnection object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DataWarehouseConnections/{connectionNo}/test": {
"post": {
"tags": [
"DataWarehouseConnections"
],
"summary": "Tests if the connection is valid.",
"operationId": "TestDataWarehouseConnection",
"parameters": [
{
"name": "connectionNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"204": {
"description": "Returns no content if the connection is valid"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataWarehouseConnection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryConditions": {
"get": {
"tags": [
"DeliveryConditions"
],
"summary": "Gets a list of Delivery Conditions",
"operationId": "GetDeliveryConditions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCondition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"DeliveryConditions"
],
"summary": "Creates a new deliveryCondition record",
"operationId": "CreateDeliveryCondition",
"requestBody": {
"description": "The deliveryCondition Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCondition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryConditions/{deliveryConditionNo}": {
"get": {
"tags": [
"DeliveryConditions"
],
"summary": "Gets a specific DeliveryCondition",
"operationId": "GetDeliveryCondition",
"parameters": [
{
"name": "deliveryConditionNo",
"in": "path",
"description": "the deliveryConditionNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested deliveryCondition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an deliveryCondition with the supplied DeliveryCondition No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCondition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"DeliveryConditions"
],
"summary": "Updates an existing deliveryCondition",
"operationId": "UpdateDeliveryCondition",
"parameters": [
{
"name": "deliveryConditionNo",
"in": "path",
"description": "The deliveryCondition of the deliveryCondition to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The deliveryCondition DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated DeliveryCondition object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCondition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"DeliveryConditions"
],
"summary": "Deletes an deliveryCondition record",
"parameters": [
{
"name": "deliveryConditionNo",
"in": "path",
"description": "The deliveryConditionNo of the deliveryCondition to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCondition_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryConditions/{deliveryConditionNo}/history": {
"get": {
"tags": [
"DeliveryConditions"
],
"summary": "Gets history for a specific DeliveryCondition",
"operationId": "GetDeliveryConditionHistory",
"parameters": [
{
"name": "deliveryConditionNo",
"in": "path",
"description": "The deliveryConditionNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested deliveryCondition",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an deliveryCondition with the supplied DeliveryCondition No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCondition_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryConditions/search": {
"post": {
"tags": [
"DeliveryConditions"
],
"summary": "Search for deliveryConditions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDeliveryConditions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCondition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryConditions/searchCount": {
"post": {
"tags": [
"DeliveryConditions"
],
"summary": "Returns number of hits in a search for DeliveryConditions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDeliveryConditions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCondition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryConditions/searchIndex/{deliveryConditionGuid}": {
"post": {
"tags": [
"DeliveryConditions"
],
"summary": "Get index of a record in a search for DeliveryConditions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDeliveryConditions",
"parameters": [
{
"name": "deliveryConditionGuid",
"in": "path",
"description": "The deliveryCondition to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCondition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryConditions/searchInfo": {
"get": {
"tags": [
"DeliveryConditions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDeliveryConditions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DeliveryConditions/{deliveryConditionNo}/copy": {
"get": {
"tags": [
"DeliveryConditions"
],
"summary": "Copies an existing deliveryCondition to a new object",
"operationId": "CopyDeliveryCondition",
"parameters": [
{
"name": "deliveryConditionNo",
"in": "path",
"description": "The DeliveryConditionNo of the deliveryCondition to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new DeliveryCondition object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCondition.DeliveryCondition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCondition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryCosts": {
"get": {
"tags": [
"DeliveryCosts"
],
"summary": "Gets a list of DeliveryCosts",
"operationId": "GetDeliveryCosts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"DeliveryCosts"
],
"summary": "Creates a new deliveryCost record",
"operationId": "CreateDeliveryCost",
"requestBody": {
"description": "The DeliveryCost Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCost_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryCosts/{deliveryCostNo}": {
"get": {
"tags": [
"DeliveryCosts"
],
"summary": "Gets a specific DeliveryCost",
"operationId": "GetDeliveryCost",
"parameters": [
{
"name": "deliveryCostNo",
"in": "path",
"description": "The DeliveryCostNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested deliveryCost",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an deliveryCost with the supplied DeliveryCost No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"DeliveryCosts"
],
"summary": "Updates an existing DeliveryCost",
"operationId": "UpdateDeliveryCost",
"parameters": [
{
"name": "deliveryCostNo",
"in": "path",
"description": "The DeliveryCostNo of the deliveryCost to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The DeliveryCost DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated DeliveryCost object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCost_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"DeliveryCosts"
],
"summary": "Deletes a deliveryCost record",
"parameters": [
{
"name": "deliveryCostNo",
"in": "path",
"description": "The DeliveryCostNo of the DeliveryCost to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCost_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryCosts/{deliveryCostNo}/history": {
"get": {
"tags": [
"DeliveryCosts"
],
"summary": "Gets history for a specific DeliveryCost",
"operationId": "GetDeliveryCostHistory",
"parameters": [
{
"name": "deliveryCostNo",
"in": "path",
"description": "The DeliveryCostNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested deliveryCost",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an deliveryCost with the supplied DeliveryCost No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCost_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryCosts/search": {
"post": {
"tags": [
"DeliveryCosts"
],
"summary": "Search for DeliveryCosts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDeliveryCosts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryCosts/searchIndex/{deliveryCostGuid}": {
"post": {
"tags": [
"DeliveryCosts"
],
"summary": "Get index of a record in a search for deliveryCost\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDeliveryCosts",
"parameters": [
{
"name": "deliveryCostGuid",
"in": "path",
"description": "The deliveryCost to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryCosts/searchCount": {
"post": {
"tags": [
"DeliveryCosts"
],
"summary": "Returns number of hits in a search for DeliveryCosts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDeliveryCosts",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DeliveryCosts/searchInfo": {
"get": {
"tags": [
"DeliveryCosts"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDeliveryCosts",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DeliveryCosts/{deliveryCostNo}/copy": {
"get": {
"tags": [
"DeliveryCosts"
],
"summary": "Copies an existing deliveryCost to a new object",
"operationId": "CopyDeliveryCost",
"parameters": [
{
"name": "deliveryCostNo",
"in": "path",
"description": "The DeliveryCostNo of the deliveryCost to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new DeliveryCost object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DeliveryCost.DeliveryCost"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DeliveryCost_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Departments": {
"get": {
"tags": [
"Departments"
],
"summary": "Gets a list of Departments",
"operationId": "GetDepartments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Departments"
],
"summary": "Creates a new department record",
"operationId": "CreateDepartment",
"requestBody": {
"description": "The Department Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Department_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Departments/{departmentNo}": {
"get": {
"tags": [
"Departments"
],
"summary": "Gets a specific Department",
"operationId": "GetDepartment",
"parameters": [
{
"name": "departmentNo",
"in": "path",
"description": "the departmentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested department",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an department with the supplied Department No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Departments"
],
"summary": "Updates an existing Department",
"operationId": "UpdateDepartment",
"parameters": [
{
"name": "departmentNo",
"in": "path",
"description": "The departmentNo of the department to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Department DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Department object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Department_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Departments"
],
"summary": "Deletes an department record",
"parameters": [
{
"name": "departmentNo",
"in": "path",
"description": "The departmentNo of the Department to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Department_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Departments/{departmentNo}/history": {
"get": {
"tags": [
"Departments"
],
"summary": "Gets history for a specific Department",
"operationId": "GetDepartmentHistory",
"parameters": [
{
"name": "departmentNo",
"in": "path",
"description": "The departmentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested department",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an department with the supplied Department No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Department_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Departments/search": {
"post": {
"tags": [
"Departments"
],
"summary": "Search for departments\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDepartments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Departments/searchCount": {
"post": {
"tags": [
"Departments"
],
"summary": "Returns number of hits in a search for Departments\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDepartments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Departments/searchIndex/{departmentGuid}": {
"post": {
"tags": [
"Departments"
],
"summary": "Get index of a record in a search for Departments\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDepartments",
"parameters": [
{
"name": "departmentGuid",
"in": "path",
"description": "The department to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Departments/searchInfo": {
"get": {
"tags": [
"Departments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDepartments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Departments/{departmentNo}/copy": {
"get": {
"tags": [
"Departments"
],
"summary": "Copies an existing department to a new object",
"operationId": "CopyDepartment",
"parameters": [
{
"name": "departmentNo",
"in": "path",
"description": "The DepartmentNo of the department to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Department object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Department.Department"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Department_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Destinations": {
"get": {
"tags": [
"Destinations"
],
"summary": "Gets a list of Destinations",
"operationId": "GetDestinations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Destinations"
],
"summary": "Creates a new Destination record",
"operationId": "CreateDestination",
"requestBody": {
"description": "The Destination Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Destination_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Destinations/{destinationNo}": {
"get": {
"tags": [
"Destinations"
],
"summary": "Gets a specific Destination",
"operationId": "GetDestination",
"parameters": [
{
"name": "destinationNo",
"in": "path",
"description": "the Destination No to get with",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Destination",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Destination with the supplied Destination No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Destinations"
],
"summary": "Updates an existing Destination",
"operationId": "UpdateDestination",
"parameters": [
{
"name": "destinationNo",
"in": "path",
"description": "The Destination No of the Destination to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Destination DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Destination object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Destination_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Destinations"
],
"summary": "Deletes an Destination record",
"parameters": [
{
"name": "destinationNo",
"in": "path",
"description": "The Destination No of the Destination to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Destination_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Destinations/{destinationNo}/history": {
"get": {
"tags": [
"Destinations"
],
"summary": "Gets history for a specific Destination",
"operationId": "GetDestinationHistory",
"parameters": [
{
"name": "destinationNo",
"in": "path",
"description": "The Destination No to get with",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested Destination history",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Destination with the supplied Destination No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Destination_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Destinations/searchInfo": {
"get": {
"tags": [
"Destinations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDestinations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Destinations/search": {
"post": {
"tags": [
"Destinations"
],
"summary": "Search for Destinations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDestinations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Destinations/searchCount": {
"post": {
"tags": [
"Destinations"
],
"summary": "Returns number of hits in a search for Destinations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDestinations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Destinations/searchIndex/{destinationGuid}": {
"post": {
"tags": [
"Destinations"
],
"summary": "Get index of a record in a search for Destinations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDestinations",
"parameters": [
{
"name": "destinationGuid",
"in": "path",
"description": "The Destination to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Destinations/{destinationNo}/copy": {
"get": {
"tags": [
"Destinations"
],
"summary": "Copies an existing Destination to a new object",
"operationId": "CopyDestination",
"parameters": [
{
"name": "destinationNo",
"in": "path",
"description": "The Destination No of the Destination to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Destination object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Destination"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Destination_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Device/confirm": {
"post": {
"tags": [
"Device"
],
"operationId": "ConfirmData",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentClasses": {
"get": {
"tags": [
"DocumentClasses"
],
"summary": "Gets a list of DocumentClasses",
"operationId": "GetDocumentClasses",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentClass | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"DocumentClasses"
],
"summary": "Creates a new documentClass record",
"operationId": "CreateDocumentClass",
"requestBody": {
"description": "The DocumentClass Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentClass_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentClasses/{documentClassNo}": {
"get": {
"tags": [
"DocumentClasses"
],
"summary": "Gets a specific DocumentClass",
"operationId": "GetDocumentClass",
"parameters": [
{
"name": "documentClassNo",
"in": "path",
"description": "The DocumentClassNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested documentClass",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an documentClass with the supplied DocumentClass No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentClass | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"DocumentClasses"
],
"summary": "Updates an existing DocumentClass",
"operationId": "UpdateDocumentClass",
"parameters": [
{
"name": "documentClassNo",
"in": "path",
"description": "The DocumentClassNo of the documentClass to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The DocumentClass DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated DocumentClass object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentClass_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"DocumentClasses"
],
"summary": "Deletes a documentClass record",
"parameters": [
{
"name": "documentClassNo",
"in": "path",
"description": "The DocumentClassNo of the DocumentClass to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentClass_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentClasses/{documentClassNo}/history": {
"get": {
"tags": [
"DocumentClasses"
],
"summary": "Gets history for a specific DocumentClass",
"operationId": "GetDocumentClassHistory",
"parameters": [
{
"name": "documentClassNo",
"in": "path",
"description": "The DocumentClassNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested documentClass",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an documentClass with the supplied DocumentClass No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentClass_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentClasses/search": {
"post": {
"tags": [
"DocumentClasses"
],
"summary": "Search for DocumentClasses\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDocumentClasses",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentClass | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentClasses/searchIndex/{documentClassGuid}": {
"post": {
"tags": [
"DocumentClasses"
],
"summary": "Get index of a record in a search for documentClass\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDocumentClasses",
"parameters": [
{
"name": "documentClassGuid",
"in": "path",
"description": "The documentClass to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentClass | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentClasses/searchCount": {
"post": {
"tags": [
"DocumentClasses"
],
"summary": "Returns number of hits in a search for DocumentClasses\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDocumentClasses",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentClass | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentClasses/searchInfo": {
"get": {
"tags": [
"DocumentClasses"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDocumentClasses",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DocumentClasses/{documentClassNo}/copy": {
"get": {
"tags": [
"DocumentClasses"
],
"summary": "Copies an existing documentClass to a new object",
"operationId": "CopyDocumentClass",
"parameters": [
{
"name": "documentClassNo",
"in": "path",
"description": "The DocumentClassNo of the documentClass to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new DocumentClass object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentClass"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentClass_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentGroups": {
"get": {
"tags": [
"DocumentGroups"
],
"summary": "Gets a list of DocumentGroups",
"operationId": "GetDocumentGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentGroup2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"DocumentGroups"
],
"summary": "Creates a new DocumentGroup record",
"operationId": "CreateDocumentGroup",
"requestBody": {
"description": "The DocumentGroup Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentGroup2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentGroups/{DocumentGroupNo}": {
"get": {
"tags": [
"DocumentGroups"
],
"summary": "Gets a specific DocumentGroup",
"operationId": "GetDocumentGroup",
"parameters": [
{
"name": "DocumentGroupNo",
"in": "path",
"description": "the DocumentGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested DocumentGroup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an DocumentGroup with the supplied DocumentGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentGroup2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"DocumentGroups"
],
"summary": "Updates an existing DocumentGroup",
"operationId": "UpdateDocumentGroup",
"parameters": [
{
"name": "DocumentGroupNo",
"in": "path",
"description": "The DocumentGroupNo of the DocumentGroup to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The DocumentGroup DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated DocumentGroup object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentGroup2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"DocumentGroups"
],
"summary": "Deletes an DocumentGroup record",
"parameters": [
{
"name": "DocumentGroupNo",
"in": "path",
"description": "The DocumentGroupNo of the DocumentGroup to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentGroup2_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentGroups/{DocumentGroupNo}/history": {
"get": {
"tags": [
"DocumentGroups"
],
"summary": "Gets history for a specific DocumentGroup",
"operationId": "GetDocumentGroupHistory",
"parameters": [
{
"name": "DocumentGroupNo",
"in": "path",
"description": "The DocumentGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested DocumentGroup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an DocumentGroup with the supplied DocumentGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentGroup2_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentGroups/search": {
"post": {
"tags": [
"DocumentGroups"
],
"summary": "Search for DocumentGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDocumentGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentGroup2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentGroups/searchCount": {
"post": {
"tags": [
"DocumentGroups"
],
"summary": "Returns number of hits in a search for DocumentGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDocumentGroups",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentGroup2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentGroups/searchIndex/{DocumentGroupGuid}": {
"post": {
"tags": [
"DocumentGroups"
],
"summary": "Get index of a record in a search for DocumentGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDocumentGroups",
"parameters": [
{
"name": "documentGroupGuid",
"in": "path",
"description": "The DocumentGroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentGroup2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentGroups/searchInfo": {
"get": {
"tags": [
"DocumentGroups"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDocumentGroups",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DocumentGroups/{DocumentGroupNo}/copy": {
"get": {
"tags": [
"DocumentGroups"
],
"summary": "Copies an existing DocumentGroup to a new object",
"operationId": "CopyDocumentGroup",
"parameters": [
{
"name": "DocumentGroupNo",
"in": "path",
"description": "The DocumentGroupNo of the DocumentGroup to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new DocumentGroup object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentGroup2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentMailTemplates": {
"get": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Gets a list of Document Mail Templates",
"operationId": "GetDocumentMailTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page number",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items per page",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentMailTemplate | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Creates a new document mail template record",
"operationId": "CreateDocumentMailTemplate",
"requestBody": {
"description": "The DocumentMailTemplate object to create",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentMailTemplate_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentMailTemplates/{documentMailTemplateNo}": {
"get": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Gets a specific Document Mail Template",
"operationId": "GetDocumentMailTemplate",
"parameters": [
{
"name": "documentMailTemplateNo",
"in": "path",
"description": "The DocumentMailTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document mail template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document mail template with the supplied no cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentMailTemplate | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Updates an existing Document Mail Template",
"operationId": "UpdateDocumentMailTemplate",
"parameters": [
{
"name": "documentMailTemplateNo",
"in": "path",
"description": "The DocumentMailTemplateNo of the template to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The DocumentMailTemplate DTO object with fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated document mail template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentMailTemplate_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Deletes a document mail template record",
"parameters": [
{
"name": "documentMailTemplateNo",
"in": "path",
"description": "The DocumentMailTemplateNo of the template to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentMailTemplate_Delete | Delete |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentMailTemplates/{documentMailTemplateNo}/history": {
"get": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Gets history for a specific Document Mail Template",
"operationId": "GetDocumentMailTemplateHistory",
"parameters": [
{
"name": "documentMailTemplateNo",
"in": "path",
"description": "The DocumentMailTemplateNo to get history for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items per page",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the history for the requested document mail template",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document mail template with the supplied no cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentMailTemplate_HistoryMode | HistoryMode |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentMailTemplates/search": {
"post": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Search for Document Mail Templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDocumentMailTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page number",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items per page",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentMailTemplate | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentMailTemplates/searchIndex/{documentMailTemplateGuid}": {
"post": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Get index of a record in a search for document mail templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDocumentMailTemplates",
"parameters": [
{
"name": "documentMailTemplateGuid",
"in": "path",
"description": "The document mail template to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentMailTemplate | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentMailTemplates/searchCount": {
"post": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Returns number of hits in a search for Document Mail Templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDocumentMailTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentMailTemplate | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentMailTemplates/searchInfo": {
"get": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDocumentMailTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DocumentMailTemplates/{documentMailTemplateNo}/copy": {
"get": {
"tags": [
"DocumentMailTemplates"
],
"summary": "Copies an existing Document Mail Template",
"operationId": "CopyDocumentMailTemplate",
"parameters": [
{
"name": "documentMailTemplateNo",
"in": "path",
"description": "The DocumentMailTemplateNo of the template to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the copied document mail template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentMailTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentMailTemplate_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents": {
"get": {
"tags": [
"Documents"
],
"summary": "Gets a list of Documents",
"operationId": "GetDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Documents"
],
"summary": "Creates a new document record",
"operationId": "CreateDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Update | Update |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}": {
"get": {
"tags": [
"Documents"
],
"summary": "Gets a specific Document",
"operationId": "GetDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Documents"
],
"summary": "Updates an existing Document",
"operationId": "UpdateDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Documents"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/searchIndex/{documentGuid}": {
"post": {
"tags": [
"Documents"
],
"summary": "Get index of a record in a search for document\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/history": {
"get": {
"tags": [
"Documents"
],
"summary": "Gets history for a specific Document",
"operationId": "GetDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/force": {
"delete": {
"tags": [
"Documents"
],
"summary": "Force deletes a document record\r\nForce deleting records may cause existing records to contain invalid data, that needs adjustment before they can be saved",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/search": {
"post": {
"tags": [
"Documents"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/searchCount": {
"post": {
"tags": [
"Documents"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/searchInfo": {
"get": {
"tags": [
"Documents"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Documents/{documentNo}/pdf": {
"get": {
"tags": [
"Documents"
],
"summary": "",
"operationId": "GetDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2 | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/file": {
"get": {
"tags": [
"Documents"
],
"summary": "",
"operationId": "GetDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2 | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Documents"
],
"operationId": "AddDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "imageDimension",
"in": "query",
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
}
},
{
"name": "imageQuality",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 80
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Update | Update |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/thumbnail": {
"get": {
"tags": [
"Documents"
],
"summary": "",
"operationId": "GetImageThumbnail",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "maxWidth",
"in": "query",
"description": "The desired width of the thumbnail, if null use height and image ratio to calculate, and if no height use default of 206px",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "maxHeight",
"in": "query",
"description": "The desired height of the thumbnail, if null use width and image ratio to calculate",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "If a document does not have a supported image file",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested iamge thumbnail"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2 | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"Documents"
],
"summary": "Get document pdf from guid",
"operationId": "GetDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"Documents"
],
"summary": "Get document file from guid",
"operationId": "GetDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/checkout": {
"put": {
"tags": [
"Documents"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/checkin": {
"post": {
"tags": [
"Documents"
],
"summary": "",
"operationId": "CheckinDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "imageQuality",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 80
}
},
{
"name": "imageDimension",
"in": "query",
"description": "",
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/copy": {
"get": {
"tags": [
"Documents"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/usage": {
"get": {
"tags": [
"Documents"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetDocumentUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/documentclasses": {
"get": {
"tags": [
"Documents"
],
"operationId": "GetDocumentDocumentClasses",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentDocumentClass"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentDocumentClass"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentDocumentClass"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/notifications": {
"get": {
"tags": [
"Documents"
],
"operationId": "GetDocumentNotifications",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentNotification"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentNotification"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentNotification"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| InextiaDocumentEmailNotification |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/zipArchive": {
"post": {
"tags": [
"Documents"
],
"operationId": "ZipDocumentArchive",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "The name for the Zip file",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns a zip file of the searched forms"
},
"404": {
"description": ""
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/propertyDefinitions": {
"get": {
"tags": [
"Documents"
],
"summary": "Get a list of PropertyDefinitions",
"operationId": "GetDocumentPropertyDefinitions",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Documents"
],
"summary": "Creates a new PropertyDefinition record",
"operationId": "CreateDocumentPropertyDefinition",
"requestBody": {
"description": "The PropertyDefinition DTO object to create",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/propertyDefinitions/{propertyDefinitionGuid}": {
"get": {
"tags": [
"Documents"
],
"summary": "Gets a specific PropertyDefinition",
"operationId": "GetDocumentPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested PropertyDefinition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an GetPropertyDefinition with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Documents"
],
"summary": "Updates an existing PropertyDefinition",
"operationId": "UpdateDocumentPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The PropertyDefinition DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PropertyDefinition object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Documents"
],
"summary": "Deletes a PropertyDefinition record",
"operationId": "DeleteDocumentPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/propertyDefinitions/{propertyDefinitionGuid}/listValues": {
"get": {
"tags": [
"Documents"
],
"summary": "Returns a list of values for a PropertyDefinition",
"operationId": "GetDocumentPropertyDefinitionListValues",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The PropertyDefinition Guid to fetch values for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "textFilter",
"in": "query",
"description": "(optional) text filter",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the values for the ListOfValuesTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/propertyDefinitions/{propertyDefinitionGuid}/force": {
"delete": {
"tags": [
"Documents"
],
"summary": "Force Deletes a PropertyDefinition record",
"operationId": "ForceDeleteDocumentPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/propertyDefinitions/{propertyName}/available": {
"get": {
"tags": [
"Documents"
],
"summary": "Lookup if PropertyName of a PropertyDefinition is not already in use and therefore available to be used",
"operationId": "DocumentPropertyNameAvailable",
"parameters": [
{
"name": "propertyName",
"in": "path",
"description": "The propertyName to check",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns true is property name is available to be used",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/screenLayout": {
"post": {
"tags": [
"Documents"
],
"summary": "Bulk updates screenlayout and a list of Property Definitions. The endpoint handles whether or not to create or update each record in the requst.",
"operationId": "BulkUpdateDocumentScreenLayout",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/documentweblinks": {
"get": {
"tags": [
"Documents"
],
"operationId": "GetDocumentDocumentWebLinks",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentDocumentClass"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentDocumentClass"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentDocumentClass"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Documents/{documentNo}/share": {
"post": {
"tags": [
"Documents"
],
"operationId": "ShareDocumentWeblink",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentShare"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentShare"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentShare"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentShare"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentShare"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentShare"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentShare"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Share | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTransactions/search": {
"post": {
"tags": [
"DocumentTransactions"
],
"summary": "Search for DocumentTransactions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDocumentTransactions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.DocumentTransaction"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.DocumentTransaction"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.DocumentTransaction"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentTransaction | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTransactions/searchInfo": {
"get": {
"tags": [
"DocumentTransactions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDocumentTransactions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DocumentTransactions/searchCount": {
"post": {
"tags": [
"DocumentTransactions"
],
"summary": "Returns number \r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDocumentTransactions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentTransaction | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTransactions/searchIndex/{documentTransactionGuid}": {
"post": {
"tags": [
"DocumentTransactions"
],
"summary": "Get index of a record in a search for document transaction\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDocumentTransactionIndex",
"parameters": [
{
"name": "documentTransactionGuid",
"in": "path",
"description": "The document transaction to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentTransaction | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTransactions/Outgoing/{documentTransactionNo}/retransmit": {
"post": {
"tags": [
"DocumentTransactions"
],
"summary": "Mark Document Transaction for Retransmission",
"operationId": "RetransmitDocumentTransaction",
"parameters": [
{
"name": "documentTransactionNo",
"in": "path",
"description": "DocumentTransactionNo",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentTransaction_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTree": {
"get": {
"tags": [
"DocumentTree"
],
"operationId": "GetDocumentRootNodes",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTree/{nodeType}/{visibleKey}/children": {
"get": {
"tags": [
"DocumentTree"
],
"operationId": "GetDocumentTreeChildren",
"parameters": [
{
"name": "nodeType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNodeType"
}
},
{
"name": "visibleKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTree/{nodeType}/{visibleKey}": {
"get": {
"tags": [
"DocumentTree"
],
"summary": "Returns a tree structure from root to where the requested object is in the tree\r\nAll nodes along the way is populated.",
"operationId": "FindDocumentTreeNodeInTree",
"parameters": [
{
"name": "nodeType",
"in": "path",
"description": "",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNodeType"
}
},
{
"name": "visibleKey",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTypes": {
"get": {
"tags": [
"DocumentTypes"
],
"summary": "Gets a list of DocumentTypes",
"operationId": "GetDocumentTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"DocumentTypes"
],
"summary": "Creates a new DocumentType record",
"operationId": "CreateDocumentType",
"requestBody": {
"description": "The DocumentType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTypes/{DocumentTypeNo}": {
"get": {
"tags": [
"DocumentTypes"
],
"summary": "Gets a specific DocumentType",
"operationId": "GetDocumentType",
"parameters": [
{
"name": "DocumentTypeNo",
"in": "path",
"description": "the DocumentTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested DocumentType",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an DocumentType with the supplied DocumentType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"DocumentTypes"
],
"summary": "Updates an existing DocumentType",
"operationId": "UpdateDocumentType",
"parameters": [
{
"name": "DocumentTypeNo",
"in": "path",
"description": "The DocumentTypeNo of the DocumentType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The DocumentType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated DocumentType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"DocumentTypes"
],
"summary": "Deletes an DocumentType record",
"parameters": [
{
"name": "DocumentTypeNo",
"in": "path",
"description": "The DocumentTypeNo of the DocumentType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTypes/{DocumentTypeNo}/history": {
"get": {
"tags": [
"DocumentTypes"
],
"summary": "Gets history for a specific DocumentType",
"operationId": "GetDocumentTypeHistory",
"parameters": [
{
"name": "DocumentTypeNo",
"in": "path",
"description": "The DocumentTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested DocumentType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an DocumentType with the supplied DocumentType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTypes/search": {
"post": {
"tags": [
"DocumentTypes"
],
"summary": "Search for DocumentTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchDocumentTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTypes/searchCount": {
"post": {
"tags": [
"DocumentTypes"
],
"summary": "Returns number of hits in a search for DocumentTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountDocumentTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTypes/searchIndex/{DocumentTypeGuid}": {
"post": {
"tags": [
"DocumentTypes"
],
"summary": "Get index of a record in a search for DocumentTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexDocumentTypes",
"parameters": [
{
"name": "documentTypeGuid",
"in": "path",
"description": "The DocumentType to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentTypes/searchInfo": {
"get": {
"tags": [
"DocumentTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoDocumentTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DocumentTypes/{DocumentTypeNo}/copy": {
"get": {
"tags": [
"DocumentTypes"
],
"summary": "Copies an existing DocumentType to a new object",
"operationId": "CopyDocumentType",
"parameters": [
{
"name": "DocumentTypeNo",
"in": "path",
"description": "The DocumentTypeNo of the DocumentType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new DocumentType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DocumentType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/DocumentWeblinks/{documentWeblinksGuid}/preview": {
"get": {
"tags": [
"DocumentWeblinks"
],
"operationId": "GetDocumentWeblinkPreview",
"parameters": [
{
"name": "documentWeblinksGuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentSharePreview"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentSharePreview"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentSharePreview"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DocumentWeblinks/{documentWeblinksGuid}/file": {
"get": {
"tags": [
"DocumentWeblinks"
],
"operationId": "GetDocumentWeblinkFile",
"parameters": [
{
"name": "documentWeblinksGuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/DocumentWeblinks/{documentWeblinksGuid}/pdf": {
"get": {
"tags": [
"DocumentWeblinks"
],
"operationId": "GetDocumentWeblinkPdf",
"parameters": [
{
"name": "documentWeblinksGuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Http.HttpResults.NotFound"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ElectronicLogbook/SetupSLB": {
"post": {
"tags": [
"ElectronicLogbook"
],
"operationId": "SetupSLBForProduction",
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Substance_Update | Update |
| LubeOilType_Update | Update |
| FuelType_Update | Update |
| LiquidType_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Embarkations/users": {
"get": {
"tags": [
"Embarkations"
],
"summary": "Gets a list of Users",
"operationId": "GetEmbarkationUsers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Embarkations/users/{userNo}": {
"get": {
"tags": [
"Embarkations"
],
"summary": "Gets a specific User",
"operationId": "GetEmbarkationUser",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The UserNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested user",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a user with the supplied User No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Embarkations/users/search": {
"post": {
"tags": [
"Embarkations"
],
"summary": "Search for Users\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchEmbarkationUsers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Embarkations/users/searchCount": {
"post": {
"tags": [
"Embarkations"
],
"summary": "Returns number of hits in a search for Users\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountEmbarkationUsers",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Embarkations/users/searchIndex/{userGuid}": {
"post": {
"tags": [
"Embarkations"
],
"summary": "Get index of a record in a search for Users\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexEmbarkationUsers",
"parameters": [
{
"name": "userGuid",
"in": "path",
"description": "The user number to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Embarkations/users/searchInfo": {
"get": {
"tags": [
"Embarkations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoEmbarkationUsers",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Embarkations/Embark": {
"post": {
"tags": [
"Embarkations"
],
"summary": "Bulk Embark a list of Users",
"operationId": "BulkEmbark",
"requestBody": {
"description": "The object containing the information to embark",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated OperationTypeConfiguration object",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Embarkation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Embarkations/Disembark/Check": {
"post": {
"tags": [
"Embarkations"
],
"summary": "Check whether a list of Users can be bulk disembarked.\r\nThis endpoint is intended for UI pre-validation when opening the disembark dialog.",
"operationId": "BulkDisembarkCheck",
"requestBody": {
"description": "The object containing the information to disembark",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Returns a ValidationResult containing warnings/errors for the dialog",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Embarkation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Embarkations/Disembark": {
"post": {
"tags": [
"Embarkations"
],
"summary": "Bulk Disembark a list of Users",
"operationId": "BulkDisembark",
"requestBody": {
"description": "The object containing the information to disembark",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated OperationTypeConfiguration object",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Embarkation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EnvironmentalItems": {
"get": {
"tags": [
"EnvironmentalItems"
],
"summary": "Gets a list of EnvironmentalItems",
"operationId": "GetEnvironmentalItems",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"EnvironmentalItems"
],
"summary": "Creates a new EnvironmentalItem record",
"operationId": "CreateEnvironmentalItem",
"requestBody": {
"description": "The EnvironmentalItem Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EnvironmentalItems/{environmentalItemNo}": {
"get": {
"tags": [
"EnvironmentalItems"
],
"summary": "Gets a specific EnvironmentalItem",
"operationId": "GetEnvironmentalItem",
"parameters": [
{
"name": "environmentalItemNo",
"in": "path",
"description": "The EnvironmentalItemNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested environmentalItem",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an environmentalItem with the supplied environmentalItem No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"EnvironmentalItems"
],
"summary": "Updates an existing EnvironmentalItem",
"operationId": "UpdateEnvironmentalItem",
"parameters": [
{
"name": "environmentalItemNo",
"in": "path",
"description": "The EnvironmentalItemNo of the environmentalItem to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The EnvironmentalItem DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated EnvironmentalItem object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"EnvironmentalItems"
],
"summary": "Deletes a EnvironmentalItem record",
"parameters": [
{
"name": "environmentalItemNo",
"in": "path",
"description": "The EnvironmentalItemNo of the EnvironmentalItem to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EnvironmentalItems/{environmentalItemNo}/history": {
"get": {
"tags": [
"EnvironmentalItems"
],
"summary": "Gets history for a specific EnvironmentalItem",
"operationId": "GetEnvironmentalItemHistory",
"parameters": [
{
"name": "environmentalItemNo",
"in": "path",
"description": "The EnvironmentalItemNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested EnvironmentalItem",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an EnvironmentalItem with the supplied EnvironmentalItem No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EnvironmentalItems/search": {
"post": {
"tags": [
"EnvironmentalItems"
],
"summary": "Search for EnvironmentalItem\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchEnvironmentalItems",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested environmentalItem",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EnvironmentalItems/searchIndex/{environmentalItem}": {
"post": {
"tags": [
"EnvironmentalItems"
],
"summary": "Get index of a record in a search for environmentalItems\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexenvironmentalItem",
"parameters": [
{
"name": "environmentalItemGuid",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "environmentalItem",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EnvironmentalItems/searchCount": {
"post": {
"tags": [
"EnvironmentalItems"
],
"summary": "Returns number of hits in a search for environmentalItems\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountEnvironmentalItems",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EnvironmentalItems/searchInfo": {
"get": {
"tags": [
"EnvironmentalItems"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoEnvironmentalItems",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/EnvironmentalItems/{environmentalItemNo}/copy": {
"get": {
"tags": [
"EnvironmentalItems"
],
"summary": "Copies an existing EnvironmentalItem to a new object",
"operationId": "CopyEnvironmentalItem",
"parameters": [
{
"name": "environmentalItemNo",
"in": "path",
"description": "The EnvironmentalItemNo of the EnvironmentalItem to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new EnvironmentalItem object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EnvironmentalItems/usage": {
"post": {
"tags": [
"EnvironmentalItems"
],
"summary": "Gets usage of Environmental Item",
"operationId": "getUsage",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page to get",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "The page size to get",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested environmentalItem",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationEnvironmentalItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationEnvironmentalItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationEnvironmentalItem"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an environmentalItem with the supplied environmentalItem No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EnvironmentalItems/usageCount": {
"post": {
"tags": [
"EnvironmentalItems"
],
"summary": "Gets usage of Environmental Item",
"operationId": "getUsageCount",
"requestBody": {
"description": "The search",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested environmentalItem",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an environmentalItem with the supplied environmentalItem No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EnvironmentalItems/{environmentalItemNo}/latestUsage": {
"get": {
"tags": [
"EnvironmentalItems"
],
"summary": "Gets latest usage of Environmental Item",
"operationId": "getLatestUsage",
"parameters": [
{
"name": "environmentalItemNo",
"in": "path",
"description": "The EnvironmentalItemNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested environmentalItem",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationEnvironmentalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationEnvironmentalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationEnvironmentalItem"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an environmentalItem with the supplied environmentalItem No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EnvironmentalItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Equipments": {
"get": {
"tags": [
"Equipments"
],
"summary": "Gets a list of Equipments",
"operationId": "GetEquipments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Equipments"
],
"summary": "Creates a new Equipment record",
"operationId": "CreateEquipment",
"requestBody": {
"description": "The Equipment Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Equipment_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Equipments/{equipmentNo}": {
"get": {
"tags": [
"Equipments"
],
"summary": "Gets a specific Equipment",
"operationId": "GetEquipment",
"parameters": [
{
"name": "equipmentNo",
"in": "path",
"description": "The Equipment to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Equipment",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Equipment with the supplied Equipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Equipments"
],
"summary": "Updates an existing Equipment",
"operationId": "UpdateEquipment",
"parameters": [
{
"name": "equipmentNo",
"in": "path",
"description": "The EquipmentNo of the equipment to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Equipment DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Equipment object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Equipment_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Equipments"
],
"summary": "Deletes a Equipment record",
"parameters": [
{
"name": "equipmentNo",
"in": "path",
"description": "The EquipmentNo of the Equipment to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Equipment_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Equipments/{equipmentNo}/history": {
"get": {
"tags": [
"Equipments"
],
"summary": "Gets history for a specific Equipment",
"operationId": "GetEquipmentHistory",
"parameters": [
{
"name": "equipmentNo",
"in": "path",
"description": "The Equipment to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested Equipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Equipment with the supplied Equipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Equipment_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Equipments/search": {
"post": {
"tags": [
"Equipments"
],
"summary": "Search for Equipment\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchEquipments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested Equipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Equipments/searchIndex/{equipmentGuid}": {
"post": {
"tags": [
"Equipments"
],
"summary": "Get index of a record in a search for Equipment\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexEquipmentGuid",
"parameters": [
{
"name": "equipmentGuid",
"in": "path",
"description": "The Equipment to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Equipments/searchCount": {
"post": {
"tags": [
"Equipments"
],
"summary": "Returns number of hits in a search for Equipment\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountEquipments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Equipments/searchInfo": {
"get": {
"tags": [
"Equipments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoEquipments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Equipments/{equipmentNo}/copy": {
"get": {
"tags": [
"Equipments"
],
"summary": "Copies an existing Equipment to a new object",
"operationId": "CopyEquipment",
"parameters": [
{
"name": "equipmentNo",
"in": "path",
"description": "The EquipmentNo of the Equipment to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Equipment object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Equipment_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Equipments/{equipmentNo}/detections": {
"get": {
"tags": [
"Equipments"
],
"summary": "Gets detections for Equipment",
"operationId": "GetEquipmentDetections",
"parameters": [
{
"name": "equipmentNo",
"in": "path",
"description": "The EquipmentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested equipment",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EquipmentDetection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EquipmentDetection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.EquipmentDetection"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a equipment with the supplied Equipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationAnswers": {
"get": {
"tags": [
"EvaluationAnswers"
],
"summary": "Gets a list of Evaluation answers",
"operationId": "GetEvaluationAnswers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"EvaluationAnswers"
],
"summary": "Creates a new evaluation answer record",
"operationId": "CreateEvaluationAnswer",
"requestBody": {
"description": "The EvaluationAnswer Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationAnswers/{evaluationAnswerNo}": {
"get": {
"tags": [
"EvaluationAnswers"
],
"summary": "Gets a specific Evaluation answer by its EvaluationAnswerNo",
"operationId": "GetEvaluationAnswer",
"parameters": [
{
"name": "evaluationAnswerNo",
"in": "path",
"description": "The EvaluationAnswerNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested evaluation answer",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an evaluation answer with the supplied EvaluationAnswerNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"EvaluationAnswers"
],
"summary": "Updates an existing EvaluationAnswer",
"operationId": "UpdateEvaluationAnswer",
"parameters": [
{
"name": "evaluationAnswerNo",
"in": "path",
"description": "The EvaluationAnswerNo of the evaluation answer to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The EvaluationAnswer DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated EvaluationAnswer object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"EvaluationAnswers"
],
"summary": "Deletes a evaluation answer record",
"parameters": [
{
"name": "evaluationAnswerNo",
"in": "path",
"description": "The EvaluationAnswerNo of the evaluation answer to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationAnswers/{evaluationAnswerNo}/history": {
"get": {
"tags": [
"EvaluationAnswers"
],
"summary": "Gets history for a specific Evaluation Answer",
"operationId": "GetEvaluationAnswerHistory",
"parameters": [
{
"name": "evaluationAnswerNo",
"in": "path",
"description": "The EvaluationAnswerNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested evaluation answer",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an evaluation answer with the supplied EvaluationAnswerNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationAnswers/search": {
"post": {
"tags": [
"EvaluationAnswers"
],
"summary": "Search for Evaluation answers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchEvaluationAnswers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationAnswers/searchIndex/{evaluationAnswerGuid}": {
"post": {
"tags": [
"EvaluationAnswers"
],
"summary": "Get index of a record in a search for evaluation answer\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexEvaluationAnswers",
"parameters": [
{
"name": "evaluationAnswerGuid",
"in": "path",
"description": "The evaluation answer to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationAnswers/searchCount": {
"post": {
"tags": [
"EvaluationAnswers"
],
"summary": "Returns number of hits in a search for Evaluation answers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountEvaluationAnswers",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationAnswers/searchInfo": {
"get": {
"tags": [
"EvaluationAnswers"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoEvaluationAnswers",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/EvaluationAnswers/{evaluationAnswerNo}/force": {
"delete": {
"tags": [
"EvaluationAnswers"
],
"summary": "Force deletes a evaluationAnswer record\r\nForce deleting records may cause existing records to contain invalid data, that needs adjustment before they can be saved",
"parameters": [
{
"name": "evaluationAnswerNo",
"in": "path",
"description": "The EvaluationAnswerNo of the evaluation answer to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationAnswers/{evaluationAnswerNo}/copy": {
"get": {
"tags": [
"EvaluationAnswers"
],
"summary": "Copies an existing evaluation answer to a new object",
"operationId": "CopyEvaluationAnswer",
"parameters": [
{
"name": "evaluationAnswerNo",
"in": "path",
"description": "The EvaluationAnswerNo of the evaluation answer to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new EvaluationAnswer object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationAnswer"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationIdentifier_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/purchaseOrderEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Creates new purchase order evaluation records",
"operationId": "CreatePurchaseOrderEvaluations",
"requestBody": {
"description": "The list of evaluation Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Updates existing evaluation records",
"operationId": "UpdatePurchaseOrderEvaluations",
"requestBody": {
"description": "The list of evaluation DTO Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/purchaseOrderEvaluations/{groupId}": {
"get": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Returns a list of Evaluations belonging to the given groupId",
"operationId": "GetPurchaseOrderEvaluationsByGroupId",
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "The groupId to fetch evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluations belonging to the groupId",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/{objectNo}/PurchaseOrderEvaluations": {
"get": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Returns a list of Evaluations belonging to the PurchaseOrder",
"operationId": "GetPurchaseOrderEvaluations",
"parameters": [
{
"name": "objectNo",
"in": "path",
"description": "The ObjectNo to fetch purchase order evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluations belonging to the purchase order",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/searchPurchaseOrderEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Search for PurchaseOrder Evaluations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPurchaseOrderEvaluations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/imInvoiceEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Creates new evaluation records",
"operationId": "CreateImInvoiceEvaluations",
"requestBody": {
"description": "The list of evaluation Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementQA |
| InvoiceManagement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Updates existing evaluation records",
"operationId": "UpdateImInvoiceEvaluations",
"requestBody": {
"description": "The list of evaluation DTO Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementQA |
| InvoiceManagement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/imInvoiceEvaluations/{groupId}": {
"get": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Returns a list of Evaluations belonging to the given groupId",
"operationId": "GetImInvoiceEvaluationsByGroupId",
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "The groupId to fetch evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluations belonging to the groupId",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementQA |
| InvoiceManagement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/{objectNo}/InvoiceEvaluations": {
"get": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Returns a list of Evaluations belonging to the Invoice",
"operationId": "GetInvoiceEvaluations",
"parameters": [
{
"name": "objectNo",
"in": "path",
"description": "The ObjectNo to fetch Invoice evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluations belonging to the Invoice",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementQA |
| InvoiceManagement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/searchInvoiceEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Search for Invoice Evaluations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchInvoiceEvaluations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementQA |
| InvoiceManagement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/requisitionEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Creates new evaluation records",
"operationId": "CreateRequisitionEvaluations",
"requestBody": {
"description": "The list of evaluation Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Updates existing evaluation records",
"operationId": "UpdateRequisitionEvaluations",
"requestBody": {
"description": "The list of evaluation DTO Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/requisitionEvaluations/{groupId}": {
"get": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Returns a list of Evaluations belonging to the given groupId",
"operationId": "GetRequisitionEvaluationsByGroupId",
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "The groupId to fetch evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluations belonging to the groupId",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/{objectNo}/RequisitionEvaluations": {
"get": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Returns a list of Evaluations belonging to the Requisition",
"operationId": "GetRequisitionEvaluations",
"parameters": [
{
"name": "objectNo",
"in": "path",
"description": "The ObjectNo to fetch Requisition evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluations belonging to the Requisition",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/searchRequisitionEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Search for Requisition Evaluations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchRequisitionEvaluations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/requestForQuoteEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Creates new evaluation records",
"operationId": "CreateRequestForQuoteEvaluations",
"requestBody": {
"description": "The list of evaluation Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Updates existing evaluation records",
"operationId": "UpdateRequestForQuoteEvaluations",
"requestBody": {
"description": "The list of evaluation DTO Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/requestForQuoteEvaluations/{groupId}": {
"get": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Returns a list of Evaluations belonging to the given groupId",
"operationId": "GetRequestForQuoteEvaluationsByGroupId",
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "The groupId to fetch evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluations belonging to the groupId",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/{objectNo}/RequestForQuoteEvaluations": {
"get": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Returns a list of Evaluations belonging to the Request For Quote",
"operationId": "GetRequestForQuoteEvaluations",
"parameters": [
{
"name": "objectNo",
"in": "path",
"description": "The ObjectNo to fetch Request For Quote evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluations belonging to the Request For Quote",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/searchRequestForQuoteEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Search for RequestForQuote Evaluations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchRequestForQuoteEvaluations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/shipmentEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Creates new evaluation records",
"operationId": "CreateShipmentEvaluations",
"requestBody": {
"description": "The list of evaluation Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Updates existing evaluation records",
"operationId": "UpdateShipmentEvaluations",
"requestBody": {
"description": "The list of evaluation DTO Objects",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/ShipmentEvaluations/{groupId}": {
"get": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Returns a list of Evaluations belonging to the given groupId",
"operationId": "GetShipmentEvaluationsByGroupId",
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "The groupId to fetch evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluations belonging to the groupId",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/{objectNo}/ShipmentEvaluations": {
"get": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Returns a list of Evaluations belonging to the Request For Quote",
"operationId": "GetShipmentEvaluations",
"parameters": [
{
"name": "objectNo",
"in": "path",
"description": "The ObjectNo to fetch Request For Quote evaluations for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluations belonging to the Request For Quote",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/searchShipmentEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Search for Shipment Evaluations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchShipmentEvaluations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/{shipmentNo}/supplierEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Creates or updates Receiving Requisition evaluations for all requisitions on a UnitShipment for a specific supplier.",
"operationId": "CreateUnitShipmentSupplierEvaluations",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the UnitShipment",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Selected evaluation answers",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentEvaluationItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentEvaluationItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentEvaluationItem"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentEvaluationItem"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns a validation result",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
| ProcurementQA |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestionObjectLinks/{shipmentNo}/pickupWarehouseEvaluations": {
"post": {
"tags": [
"EvaluationQuestionObjectLinks"
],
"summary": "Creates or updates Receiving Shipment evaluations for all pickup warehouse suppliers on a UnitShipment.",
"operationId": "CreateUnitShipmentPickupWarehouseEvaluations",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the UnitShipment",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Selected evaluation answers",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentEvaluationItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentEvaluationItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentEvaluationItem"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentEvaluationItem"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns a validation result",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
| ProcurementQA |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions": {
"get": {
"tags": [
"EvaluationQuestions"
],
"summary": "Gets a list of Evaluation questions",
"operationId": "GetEvaluationQuestions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"EvaluationQuestions"
],
"summary": "Creates a new evaluation question record",
"operationId": "CreateEvaluationQuestion",
"requestBody": {
"description": "The EvaluationQuestion Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/{evaluationQuestionNo}": {
"get": {
"tags": [
"EvaluationQuestions"
],
"summary": "Gets a specific Evaluation question by its EvaluationQuestionNo",
"operationId": "GetEvaluationQuestion",
"parameters": [
{
"name": "evaluationQuestionNo",
"in": "path",
"description": "The EvaluationQuestionNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested evaluation question",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an evaluation question with the supplied EvaluationQuestionNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"EvaluationQuestions"
],
"summary": "Updates an existing EvaluationQuestion",
"operationId": "UpdateEvaluationQuestion",
"parameters": [
{
"name": "evaluationQuestionNo",
"in": "path",
"description": "The EvaluationQuestionNo of the evaluation question to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The EvaluationQuestion DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated EvaluationQuestion object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"EvaluationQuestions"
],
"summary": "Deletes a evaluation question record",
"parameters": [
{
"name": "evaluationQuestionNo",
"in": "path",
"description": "The EvaluationQuestionNo of the evaluation question to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/{evaluationQuestionNo}/history": {
"get": {
"tags": [
"EvaluationQuestions"
],
"summary": "Gets history for a specific Evaluation Question",
"operationId": "GetEvaluationQuestionHistory",
"parameters": [
{
"name": "evaluationQuestionNo",
"in": "path",
"description": "The EvaluationQuestionNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested evaluation question",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an evaluation question with the supplied EvaluationQuestionNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/search": {
"post": {
"tags": [
"EvaluationQuestions"
],
"summary": "Search for Evaluation questions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchEvaluationQuestions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/{objectNo}/searchEvaluationQuestionsForEvaluationDialog": {
"post": {
"tags": [
"EvaluationQuestions"
],
"summary": "Search for Evaluation Questions to be used for Evaluation Dialog\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchEvaluationQuestionsForEvaluationDialog",
"parameters": [
{
"name": "objectNo",
"in": "path",
"description": "No of the object that is to be evaluated on",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/searchIndex/{evaluationQuestionGuid}": {
"post": {
"tags": [
"EvaluationQuestions"
],
"summary": "Get index of a record in a search for evaluation question\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexEvaluationQuestions",
"parameters": [
{
"name": "evaluationQuestionGuid",
"in": "path",
"description": "The evaluation question to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/searchCount": {
"post": {
"tags": [
"EvaluationQuestions"
],
"summary": "Returns number of hits in a search for Evaluation questions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountEvaluationQuestions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/searchInfo": {
"get": {
"tags": [
"EvaluationQuestions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoEvaluationQuestions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/EvaluationQuestions/{evaluationQuestionNo}/copy": {
"get": {
"tags": [
"EvaluationQuestions"
],
"summary": "Copies an existing evaluation question to a new object",
"operationId": "CopyEvaluationQuestion",
"parameters": [
{
"name": "evaluationQuestionNo",
"in": "path",
"description": "The EvaluationQuestionNo of the evaluation question to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new EvaluationQuestion object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestion"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/{evaluationQuestionNo}/companies": {
"get": {
"tags": [
"EvaluationQuestions"
],
"summary": "Gets a list of Evaluation Question Companies",
"operationId": "GetEvaluationQuestionCompanies",
"parameters": [
{
"name": "evaluationQuestionNo",
"in": "path",
"description": "The No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionCompany"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionCompany"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionCompany"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/{evaluationQuestionNo}/addressCategories": {
"get": {
"tags": [
"EvaluationQuestions"
],
"summary": "Gets a list of Evaluation Question Address Categories",
"operationId": "GetEvaluationQuestionAddressCategories",
"parameters": [
{
"name": "evaluationQuestionNo",
"in": "path",
"description": "The No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionAddressCategory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionAddressCategory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionAddressCategory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/{evaluationQuestionNo}/itemTypes": {
"get": {
"tags": [
"EvaluationQuestions"
],
"summary": "Gets a list of Evaluation Question Item Types",
"operationId": "GetEvaluationQuestionItemTypes",
"parameters": [
{
"name": "evaluationQuestionNo",
"in": "path",
"description": "The No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionItemType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionItemType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionItemType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EvaluationQuestions/{evaluationQuestionNo}/evaluationAnswers": {
"get": {
"tags": [
"EvaluationQuestions"
],
"summary": "Gets a list of Evaluation Question Evaluation Answers",
"operationId": "GetEvaluationQuestionEvaluationAnswers",
"parameters": [
{
"name": "evaluationQuestionNo",
"in": "path",
"description": "The No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionEvaluationAnswer"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionEvaluationAnswer"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionEvaluationAnswer"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EvaluationItem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EventReports": {
"get": {
"tags": [
"EventReports"
],
"summary": "Gets a list of Event Reports",
"operationId": "GetEventReports",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EventReports/{eventReportNo}": {
"get": {
"tags": [
"EventReports"
],
"summary": "Gets a specific EventReport",
"operationId": "GetEventReport",
"parameters": [
{
"name": "eventReportNo",
"in": "path",
"description": "The eventReportNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested event report",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an event report with the supplied EventReport No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EventReports/{eventReportNo}/history": {
"get": {
"tags": [
"EventReports"
],
"summary": "Gets history for a specific EventReport",
"operationId": "GetEventReportHistory",
"parameters": [
{
"name": "eventReportNo",
"in": "path",
"description": "The eventReportNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested EventReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an EventReport with the supplied EventReport No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EventReport2_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EventReports/search": {
"post": {
"tags": [
"EventReports"
],
"summary": "Search for EventReports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchEventReports",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EventReports/searchIndex/{eventReportGuid}": {
"post": {
"tags": [
"EventReports"
],
"summary": "Get index of a record in a search for EventReport\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexEventReports",
"parameters": [
{
"name": "eventReportGuid",
"in": "path",
"description": "The EventReport to find index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EventReports/searchCount": {
"post": {
"tags": [
"EventReports"
],
"summary": "Returns number of hits in a search for EventReports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountEventReports",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EventReports/searchInfo": {
"get": {
"tags": [
"EventReports"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoEventReports",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/EventReports/{eventReportNo}/approve": {
"post": {
"tags": [
"EventReports"
],
"summary": "Approve EventReport",
"operationId": "ApproveEventReport",
"parameters": [
{
"name": "eventReportNo",
"in": "path",
"description": "The eventReportNo to reject",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The info needed to reject the EventReport",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReportApprovalInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReportApprovalInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReportApprovalInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReportApprovalInfo"
}
}
}
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.UnauthorizedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.UnauthorizedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.UnauthorizedResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundObjectResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundObjectResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundObjectResult"
}
}
}
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EventReport2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/EventReports/{eventReportNo}/reject": {
"post": {
"tags": [
"EventReports"
],
"summary": "Reject EventReport",
"operationId": "RejectEventReport",
"parameters": [
{
"name": "eventReportNo",
"in": "path",
"description": "The eventReportNo to reject",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The info needed to reject the EventReport",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReportApprovalInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReportApprovalInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReportApprovalInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.EventReport.EventReportApprovalInfo"
}
}
}
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.UnauthorizedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.UnauthorizedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.UnauthorizedResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundObjectResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundObjectResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundObjectResult"
}
}
}
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| EventReport2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExcelImport": {
"get": {
"tags": [
"ExcelImport"
],
"operationId": "Get",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExcelImport/Validate": {
"post": {
"tags": [
"ExcelImport"
],
"operationId": "Validate",
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExcelImport/Build": {
"post": {
"tags": [
"ExcelImport"
],
"operationId": "Build",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExcelImport/Import": {
"post": {
"tags": [
"ExcelImport"
],
"operationId": "Import",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExpectedFaults": {
"get": {
"tags": [
"ExpectedFaults"
],
"summary": "Gets a list of ExpectedFaults",
"operationId": "GetExpectedFaults",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExpectedFault | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ExpectedFaults"
],
"summary": "Creates a new expectedFault record",
"operationId": "CreateExpectedFault",
"requestBody": {
"description": "The expectedFault Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExpectedFault_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExpectedFaults/{expectedFaultNo}": {
"get": {
"tags": [
"ExpectedFaults"
],
"summary": "Gets a specific expectedFault",
"operationId": "GetExpectedFault",
"parameters": [
{
"name": "expectedFaultNo",
"in": "path",
"description": "The ExpectedFaultNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested expectedFault",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an expectedFault with the supplied expectedFault No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExpectedFault | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ExpectedFaults"
],
"summary": "Updates an existing expectedFault",
"operationId": "UpdateExpectedFault",
"parameters": [
{
"name": "expectedFaultNo",
"in": "path",
"description": "The ExpectedFaultNo of the expectedFault to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The expectedFault DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated expectedFault object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExpectedFault_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ExpectedFaults"
],
"summary": "Deletes a expectedFault record",
"parameters": [
{
"name": "expectedFaultNo",
"in": "path",
"description": "The ExpectedFaultNo of the expectedFault to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExpectedFault_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExpectedFaults/{expectedFaultNo}/history": {
"get": {
"tags": [
"ExpectedFaults"
],
"summary": "Gets history for a specific expectedFault",
"operationId": "GetexpectedFaultHistory",
"parameters": [
{
"name": "expectedFaultNo",
"in": "path",
"description": "The ExpectedFaultNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested expectedFault",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an expectedFault with the supplied expectedFault No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExpectedFault_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExpectedFaults/search": {
"post": {
"tags": [
"ExpectedFaults"
],
"summary": "Search for ExpectedFaults\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchExpectedFaults",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested expectedFault",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExpectedFault | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExpectedFaults/searchIndex/{expectedFaultGuid}": {
"post": {
"tags": [
"ExpectedFaults"
],
"summary": "Get index of a record in a search for ExpectedFaults\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexExpectedFaults",
"parameters": [
{
"name": "expectedFaultGuid",
"in": "path",
"description": "The expectedFault to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExpectedFault | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExpectedFaults/searchCount": {
"post": {
"tags": [
"ExpectedFaults"
],
"summary": "Returns number of hits in a search for ExpectedFaults\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountExpectedFaults",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExpectedFault | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExpectedFaults/searchInfo": {
"get": {
"tags": [
"ExpectedFaults"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoExpectedFaults",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ExpectedFaults/{expectedFaultNo}/copy": {
"get": {
"tags": [
"ExpectedFaults"
],
"summary": "Copies an existing expectedFault to a new object",
"operationId": "CopyExpectedFault",
"parameters": [
{
"name": "expectedFaultNo",
"in": "path",
"description": "The ExpectedFaultNo of the expectedFault to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new expectedFault object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExpectedFault.ExpectedFault"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExpectedFault_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExternalCalendars/search": {
"post": {
"tags": [
"ExternalCalendars"
],
"summary": "Returns an array of ApiWebhookExecuteResult by executing all active ExternalCalendar webhooks.\r\nUsed to call Lua scripts that can fetch external calendar events and integrate them into Sertica 6/INEXTIA.",
"operationId": "Search",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.ApiWebhookExecuteResult"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.ApiWebhookExecuteResult"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.ApiWebhookExecuteResult"
}
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ReadExternalCalendar | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExternalItems": {
"get": {
"tags": [
"ExternalItems"
],
"summary": "Gets a list of ExternalItems",
"operationId": "GetExternalItems",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ExternalItems"
],
"summary": "Creates a new externalItem record",
"operationId": "CreateExternalItem",
"requestBody": {
"description": "The ExternalItem Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExternalItem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExternalItems/{externalItemNo}": {
"get": {
"tags": [
"ExternalItems"
],
"summary": "Gets a specific ExternalItem",
"operationId": "GetExternalItem",
"parameters": [
{
"name": "externalItemNo",
"in": "path",
"description": "The ExternalItemNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested externalItem",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an externalItem with the supplied ExternalItem No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ExternalItems"
],
"summary": "Updates an existing ExternalItem",
"operationId": "UpdateExternalItem",
"parameters": [
{
"name": "externalItemNo",
"in": "path",
"description": "The ExternalItemNo of the externalItem to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ExternalItem DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ExternalItem object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExternalItem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ExternalItems"
],
"summary": "Deletes a externalItem record",
"parameters": [
{
"name": "externalItemNo",
"in": "path",
"description": "The ExternalItemNo of the ExternalItem to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ExternalItem_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExternalItems/search": {
"post": {
"tags": [
"ExternalItems"
],
"summary": "Search for ExternalItems\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchExternalItems",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ExternalItem.ExternalItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExternalItems/searchIndex/{externalItemGuid}": {
"post": {
"tags": [
"ExternalItems"
],
"summary": "Get index of a record in a search for externalItem\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexExternalItems",
"parameters": [
{
"name": "externalItemGuid",
"in": "path",
"description": "The externalItem to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExternalItems/searchCount": {
"post": {
"tags": [
"ExternalItems"
],
"summary": "Returns number of hits in a search for ExternalItems\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountExternalItems",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ExternalItems/searchInfo": {
"get": {
"tags": [
"ExternalItems"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoExternalItems",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/FinancialFollowupNodeResponses": {
"post": {
"tags": [
"FinancialFollowupNodeResponses"
],
"summary": "Creates a new FinancialFollowupNodeResponse record",
"operationId": "CreateFinancialFollowupNodeResponse",
"requestBody": {
"description": "The FinancialFollowupNodeResponse Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FinancialFollowup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FinancialFollowupNodeResponses/{guid}": {
"get": {
"tags": [
"FinancialFollowupNodeResponses"
],
"summary": "Gets a specific FinancialFollowupNodeResponse record",
"operationId": "GetFinancialFollowupNodeResponse",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "the guid to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested FinancialFollowupNodeResponse",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a FinancialFollowupNodeResponse with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FinancialFollowup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"FinancialFollowupNodeResponses"
],
"summary": "Deletes an FinancialFollowupNodeResponse record",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid of the FinancialFollowUpNodeResponse to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FinancialFollowup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Flags": {
"get": {
"tags": [
"Flags"
],
"summary": "Gets a list of Flags",
"operationId": "GetFlags",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Flags"
],
"summary": "Creates a new flag record",
"operationId": "CreateFlag",
"requestBody": {
"description": "The Flag Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Flag_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Flags/{flagNo}": {
"get": {
"tags": [
"Flags"
],
"summary": "Gets a specific Flag",
"operationId": "GetFlag",
"parameters": [
{
"name": "flagNo",
"in": "path",
"description": "The FlagNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested flag",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an flag with the supplied Flag No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Flags"
],
"summary": "Updates an existing Flag",
"operationId": "UpdateFlag",
"parameters": [
{
"name": "flagNo",
"in": "path",
"description": "The FlagNo of the flag to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Flag DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Flag object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Flag_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Flags"
],
"summary": "Deletes a flag record",
"parameters": [
{
"name": "flagNo",
"in": "path",
"description": "The FlagNo of the Flag to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Flag_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Flags/{flagNo}/history": {
"get": {
"tags": [
"Flags"
],
"summary": "Gets history for a specific Flag",
"operationId": "GetFlagHistory",
"parameters": [
{
"name": "flagNo",
"in": "path",
"description": "The FlagNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested flag",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an flag with the supplied Flag No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Flag_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Flags/search": {
"post": {
"tags": [
"Flags"
],
"summary": "Search for Flags\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchFlags",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested flag",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Flags/searchIndex/{flagGuid}": {
"post": {
"tags": [
"Flags"
],
"summary": "Get index of a record in a search for flags\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexFlags",
"parameters": [
{
"name": "flagGuid",
"in": "path",
"description": "The flag to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Flags/searchCount": {
"post": {
"tags": [
"Flags"
],
"summary": "Returns number of hits in a search for Flags\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountFlags",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Flags/searchInfo": {
"get": {
"tags": [
"Flags"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoFlags",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Flags/{flagNo}/copy": {
"get": {
"tags": [
"Flags"
],
"summary": "Copies an existing Flag to a new object",
"operationId": "CopyFlag",
"parameters": [
{
"name": "flagNo",
"in": "path",
"description": "The FlagNo of the flag to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Flag object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Flag"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Flag_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormBrowser": {
"get": {
"tags": [
"FormBrowser"
],
"operationId": "FormBrowser",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormBrowser/{nodeType}/children": {
"post": {
"tags": [
"FormBrowser"
],
"summary": "Returns the child nodes of the requested object",
"operationId": "GetFormBrowserChildren",
"parameters": [
{
"name": "nodeType",
"in": "path",
"description": "",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeType"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeKeys"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeKeys"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeKeys"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeKeys"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormBrowser/{nodeType}": {
"post": {
"tags": [
"FormBrowser"
],
"summary": "Returns the Form Browser tree from root to where the requested object is in the tree\r\nAll nodes along the way is populated.",
"operationId": "GetTree",
"parameters": [
{
"name": "nodeType",
"in": "path",
"description": "",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeType"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeKeys"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeKeys"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeKeys"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeKeys"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments": {
"get": {
"tags": [
"FormDocuments"
],
"summary": "Gets a list of FormDocuments",
"operationId": "GetFormDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FormDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateFormDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/{documentNo}": {
"get": {
"tags": [
"FormDocuments"
],
"summary": "Gets a specific FormDocument",
"operationId": "GetFormDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"FormDocuments"
],
"summary": "Updates an existing Document",
"operationId": "UpdateFormDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"FormDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"FormDocuments"
],
"summary": "Get index of a record in a search for FormDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexFormDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/{documentNo}/history": {
"get": {
"tags": [
"FormDocuments"
],
"summary": "Gets history for a specific FormDocument",
"operationId": "GetFormDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/search": {
"post": {
"tags": [
"FormDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchFormDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/searchCount": {
"post": {
"tags": [
"FormDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountFormDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/searchInfo": {
"get": {
"tags": [
"FormDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoFormDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/FormDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"FormDocuments"
],
"summary": "",
"operationId": "GetFormDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/{documentNo}/file": {
"get": {
"tags": [
"FormDocuments"
],
"summary": "",
"operationId": "GetFormDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FormDocuments"
],
"operationId": "AddFormDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"FormDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetFormDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"FormDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetFormDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/{documentNo}/copy": {
"get": {
"tags": [
"FormDocuments"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyFormDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormDocuments/{documentNo}/usage": {
"get": {
"tags": [
"FormDocuments"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetFormDocumentsUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms": {
"get": {
"tags": [
"Forms"
],
"summary": "Gets a list of Forms",
"operationId": "GetForms",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Forms"
],
"summary": "Creates a new form record",
"operationId": "CreateForm",
"requestBody": {
"description": "The Form Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}": {
"get": {
"tags": [
"Forms"
],
"summary": "Gets a specific Form",
"operationId": "GetForm",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The FormNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested form",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form with the supplied Form No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Forms"
],
"summary": "Updates an existing Form",
"operationId": "UpdateForm",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The FormNo of the form to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Form DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Form object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Forms"
],
"summary": "Deletes a form record",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The FormNo of the Form to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/fromFormTemplate/{formTemplateNo}": {
"get": {
"tags": [
"Forms"
],
"summary": "Gets a non-created Form made from a Form Template",
"operationId": "GetFormFromFormTemplate",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"description": "The FormTempalte no from where the Form should be created",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/copy": {
"get": {
"tags": [
"Forms"
],
"summary": "Copies an existing Form to a new object",
"operationId": "CopyForm",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The FormNo of the form to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Form object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/formUpdateDocument": {
"post": {
"tags": [
"Forms"
],
"operationId": "FormUpdateDocument",
"parameters": [
{
"name": "formNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/search": {
"post": {
"tags": [
"Forms"
],
"summary": "Search for Form\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchForms",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/searchIndex/{formGuid}": {
"post": {
"tags": [
"Forms"
],
"summary": "Get index of a record in a search for form\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexForms",
"parameters": [
{
"name": "formGuid",
"in": "path",
"description": "The form to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/searchCount": {
"post": {
"tags": [
"Forms"
],
"summary": "Returns number of hits in a search for Form\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountForms",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/searchInfo": {
"get": {
"tags": [
"Forms"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoForms",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Forms/search/{formTemplateNo}": {
"post": {
"tags": [
"Forms"
],
"summary": "Search for forms using a specific FormTemplate\r\nTakes a Form Template No. and a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchFormTemplateNo",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/searchInfo/{formTemplateNo}": {
"get": {
"tags": [
"Forms"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoFormsByTemplateNo",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a list of valid search fields based on the given Form Template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/searchCount/{formTemplateNo}": {
"post": {
"tags": [
"Forms"
],
"summary": "Returns number of hits in a search for Forms using a specific Form Template\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountFormsByTemplateNo",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/searchIndex/{formGuid}/{formTemplateNo}": {
"post": {
"tags": [
"Forms"
],
"summary": "Get index of a record in a search for Forms using a specific Form Template\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexFormsByTemplateNo",
"parameters": [
{
"name": "formGuid",
"in": "path",
"description": "The form to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "formTemplateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/history": {
"get": {
"tags": [
"Forms"
],
"summary": "Gets history for a specific Form",
"operationId": "GetFormHistory",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The FormNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested form",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form with the supplied Form No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/formprint": {
"get": {
"tags": [
"Forms"
],
"operationId": "GetFormPrint",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The Form no to print form for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested form print as pdf"
},
"404": {
"description": "If a Form with the supplied Form No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/zipArchive": {
"post": {
"tags": [
"Forms"
],
"operationId": "ZipFormsArchive",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "The name for the Zip file",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns a zip file of the searched forms"
},
"404": {
"description": ""
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/formresponses": {
"get": {
"tags": [
"Forms"
],
"summary": "Fetches all Responses attached to the form",
"operationId": "GetFormResponses",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The FormNo to fetch fomrResponses for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "orderByAscCreateDate",
"in": "query",
"description": "Should result be order by create date",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Returns the formResponses for the form",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/formresponses/count": {
"get": {
"tags": [
"Forms"
],
"summary": "Returns number of FormResponses for formNo",
"operationId": "CountFormResponses",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The Form No",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/addformresponse": {
"post": {
"tags": [
"Forms"
],
"summary": "Add response",
"operationId": "AddFormResponse",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The formNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The FormResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/usage": {
"get": {
"tags": [
"Forms"
],
"summary": "Gets usages for a specific Form",
"operationId": "GetFormUsages",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The Form No. to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested form's usages",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Forms.FormUsageView"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Forms.FormUsageView"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Forms.FormUsageView"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form with the supplied Form No cannot be found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/documents": {
"get": {
"tags": [
"Forms"
],
"summary": "Returns a list of Documents on the Form",
"operationId": "GetFormDocumentLinks",
"parameters": [
{
"name": "formNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/forms/{formNo}/approve": {
"post": {
"tags": [
"Forms"
],
"summary": "Approve Form",
"operationId": "ApproveForm",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The Formno to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/forms/{formNo}/reject": {
"post": {
"tags": [
"Forms"
],
"summary": "Reject Form",
"operationId": "RejectForm",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The Formno to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The reason for the rejection",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormRejectReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormRejectReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormRejectReason"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormRejectReason"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/forms/{formNo}/requestApproval": {
"post": {
"tags": [
"Forms"
],
"summary": "Request Approval of Form",
"operationId": "RequestApproval",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The Formno to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/forms/{formNo}/reopen": {
"post": {
"tags": [
"Forms"
],
"summary": "Reopen Form",
"operationId": "ReopenForm",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The Formno to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/formActions": {
"get": {
"tags": [
"Forms"
],
"summary": "Returns a bool telling if the User is allowed to approve the Form",
"operationId": "GetFormActions",
"parameters": [
{
"name": "formNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormActions"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormActions"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormActions"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/approvers": {
"get": {
"tags": [
"Forms"
],
"summary": "Returns a list of Approvers on the Form",
"operationId": "GetFormApprovers",
"parameters": [
{
"name": "formNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormApprover"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormApprover"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormApprover"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/{formNo}/confidentialityUserRoles": {
"get": {
"tags": [
"Forms"
],
"summary": "Fetches all ConfidentialityUserRoles attached to the Form",
"operationId": "GetFormConfidentialityUserRoles",
"parameters": [
{
"name": "formNo",
"in": "path",
"description": "The FormNo to fetch ConfidentialityUserRole for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the ConfidentialityUserRoles for the Form",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormConfidentialityUserRole"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormConfidentialityUserRole"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormConfidentialityUserRole"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/appRequest": {
"post": {
"tags": [
"Forms"
],
"summary": "Get Forms for App",
"operationId": "FormAppRequest",
"requestBody": {
"description": "The request",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/appRequest/{guid}": {
"get": {
"tags": [
"Forms"
],
"summary": "Get Form for App by Guid",
"operationId": "FormGuidAppRequest",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/appFormPDFPreview": {
"post": {
"tags": [
"Forms"
],
"operationId": "FormAppPDFPreview",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/appSubmit": {
"post": {
"tags": [
"Forms"
],
"summary": "Submits a Form from App",
"operationId": "FormAppSubmit",
"requestBody": {
"description": "The Form to submit",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Forms/tasklistFormNodes": {
"get": {
"tags": [
"Forms"
],
"summary": "Get forms browser nodes",
"operationId": "GetFormBrowserNodes ",
"responses": {
"200": {
"description": "Returns all forms nodes as children of root node",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.Form"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature": {
"get": {
"tags": [
"FormsSignature"
],
"summary": "Gets a list of FormsSignature",
"operationId": "GetFormsSignature",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FormsSignature"
],
"summary": "Creates a new document record",
"operationId": "CreateFormSignature",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/{documentNo}": {
"get": {
"tags": [
"FormsSignature"
],
"summary": "Gets a specific FormSignature",
"operationId": "GetFormSignature",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"FormsSignature"
],
"summary": "Updates an existing Document",
"operationId": "UpdateFormSignature",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"FormsSignature"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Delete | Delete |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/searchIndex/{documentGuid}": {
"post": {
"tags": [
"FormsSignature"
],
"summary": "Get index of a record in a search for FormSignature\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexFormsSignature",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/{documentNo}/history": {
"get": {
"tags": [
"FormsSignature"
],
"summary": "Gets history for a specific FormSignature",
"operationId": "GetFormSignatureHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_HistoryMode | HistoryMode |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/search": {
"post": {
"tags": [
"FormsSignature"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchFormsSignature",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/searchCount": {
"post": {
"tags": [
"FormsSignature"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountFormsSignature",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/searchInfo": {
"get": {
"tags": [
"FormsSignature"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoFormsSignature",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/FormsSignature/{documentNo}/pdf": {
"get": {
"tags": [
"FormsSignature"
],
"summary": "",
"operationId": "GetFormSignaturePdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/{documentNo}/file": {
"get": {
"tags": [
"FormsSignature"
],
"summary": "",
"operationId": "GetFormSignatureFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FormsSignature"
],
"operationId": "AddFormSignatureFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"FormsSignature"
],
"summary": "Get document pdf from guid",
"operationId": "GetFormSignaturePdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"FormsSignature"
],
"summary": "Get document file from guid",
"operationId": "GetFormSignatureFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/{documentNo}/checkout": {
"put": {
"tags": [
"FormsSignature"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutFormSignatureFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormsSignature/{documentNo}/checkin": {
"post": {
"tags": [
"FormsSignature"
],
"summary": "",
"operationId": "CheckinFormSignatureFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Form_Update | Update |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments": {
"get": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Gets a list of FormTemplateDocuments",
"operationId": "GetFormTemplateDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateFormTemplateDocument",
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/{documentNo}": {
"get": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Gets a specific FormTemplateDocument",
"operationId": "GetFormTemplateDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Updates an existing Document",
"operationId": "UpdateFormTemplateDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Get index of a record in a search for FormTemplateDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexFormTemplateDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/{documentNo}/history": {
"get": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Gets history for a specific FormTemplateDocument",
"operationId": "GetFormTemplateDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/search": {
"post": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchFormTemplateDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/searchCount": {
"post": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountFormTemplateDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/searchInfo": {
"get": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoFormTemplateDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/FormTemplateDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"FormTemplateDocuments"
],
"summary": "",
"operationId": "GetFormTemplateDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/{documentNo}/file": {
"get": {
"tags": [
"FormTemplateDocuments"
],
"summary": "",
"operationId": "GetFormTemplateDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FormTemplateDocuments"
],
"operationId": "AddFormTemplateDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetFormTemplateDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetFormTemplateDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/{documentNo}/checkout": {
"put": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutFormTemplateDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/{documentNo}/checkin": {
"post": {
"tags": [
"FormTemplateDocuments"
],
"summary": "",
"operationId": "CheckinFormTemplateDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/{documentNo}/copy": {
"get": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyFormTemplateDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateDocuments/{documentNo}/usage": {
"get": {
"tags": [
"FormTemplateDocuments"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetFormTemplateDocumentsUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments": {
"get": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Gets a list of FormTemplateHelpImageDocuments",
"operationId": "GetFormTemplateHelpImageDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateFormTemplateHelpImageDocument",
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/{documentNo}": {
"get": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Gets a specific FormTemplateHelpImageDocument",
"operationId": "GetFormTemplateHelpImageDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Updates an existing Document",
"operationId": "UpdateFormTemplateHelpImageDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Get index of a record in a search for FormTemplateHelpImageDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexFormTemplateHelpImageDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/{documentNo}/history": {
"get": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Gets history for a specific FormTemplateHelpImageDocument",
"operationId": "GetFormTemplateHelpImageDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/search": {
"post": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchFormTemplateHelpImageDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/searchCount": {
"post": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountFormTemplateHelpImageDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/searchInfo": {
"get": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoFormTemplateHelpImageDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/FormTemplateHelpImageDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "",
"operationId": "GetFormTemplateHelpImageDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/{documentNo}/file": {
"get": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "",
"operationId": "GetFormTemplateHelpImageDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"operationId": "AddFormTemplateHelpImageDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "imageDimension",
"in": "query",
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
}
},
{
"name": "imageQuality",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 80
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetFormTemplateHelpImageDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetFormTemplateHelpImageDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/{documentNo}/checkout": {
"put": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutFormTemplateHelpImageDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/{documentNo}/checkin": {
"post": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "",
"operationId": "CheckinFormTemplateHelpImageDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/{documentNo}/copy": {
"get": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyFormTemplateHelpImageDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateHelpImageDocuments/{documentNo}/usage": {
"get": {
"tags": [
"FormTemplateHelpImageDocuments"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetFormTemplateHelpImageDocumentsUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Gets a list of Form Templates",
"operationId": "GetFormTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FormTemplates"
],
"summary": "Creates a new form template record",
"operationId": "CreateFormTemplate",
"requestBody": {
"description": "The Form Template Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Gets a specific FormTemplate",
"operationId": "GetFormTemplate",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"description": "The FormTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested form template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form template with the supplied Form Template No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"FormTemplates"
],
"summary": "Updates an existing FormTemplate",
"operationId": "UpdateFormTemplate",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"description": "The FormTemplateNo of the form template to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Form Template DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated FormTemplate object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"FormTemplates"
],
"summary": "Deletes a form template record",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"description": "The FormTemplateNo of the FormTemplate to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/history": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Gets history for a specific FormTemplate",
"operationId": "GetFormTemplateHistory",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"description": "The FormTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested form template",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form template with the supplied Form Template No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/search": {
"post": {
"tags": [
"FormTemplates"
],
"summary": "Search for Form Templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchFormTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/searchIndex/{formTemplateGuid}": {
"post": {
"tags": [
"FormTemplates"
],
"summary": "Get index of a record in a search for form templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexFormTemplates",
"parameters": [
{
"name": "formTemplateGuid",
"in": "path",
"description": "The form template to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/searchCount": {
"post": {
"tags": [
"FormTemplates"
],
"summary": "Returns number of hits in a search for Form Templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountFormTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/searchInfo": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoFormTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/FormTemplates/{formTemplateNo}/copy": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Copies an existing FormTemplate to a new object",
"operationId": "CopyFormTemplate",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"description": "The FormTemplateNo of the formTemplate to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new FormTemplate object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/availableTags/{columnType}": {
"get": {
"tags": [
"FormTemplates"
],
"parameters": [
{
"name": "columnType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FieldFormFieldsTypeColumnTypes"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WordFields"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WordFields"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WordFields"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/appRequest": {
"post": {
"tags": [
"FormTemplates"
],
"summary": "Get FormTemplates for App",
"operationId": "FormTemplateAppRequest",
"requestBody": {
"description": "The request",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppObject"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppObject"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppObject"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/appRequest/{guid}": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Get Form Template for App by Guid",
"operationId": "FormTemplateGuidAppRequest",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppObject"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/confidentialityUserRoles": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Fetches all ConfidentialityUserRoles attached to the FormTemplate",
"operationId": "GetConfidentialityUserRoles",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"description": "The FormTemplateNo to fetch ConfidentialityUserRole for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the ConfidentialityUserRoles for the FormTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateConfidentialityUserRole"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateConfidentialityUserRole"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateConfidentialityUserRole"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/FunctionAreas": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Returns a list of Function Areas on the Form Template",
"operationId": "GetFormTemplateFunctionAreas",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateFunctionArea"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateFunctionArea"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateFunctionArea"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/Approvers": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Returns a list of Approvers on the Form Template",
"operationId": "GetFormTemplateApprovers",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateApprover"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateApprover"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateApprover"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/AutomaticDeletions": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Returns a list of AutomaticDeletions on the Form Template",
"operationId": "GetFormTemplateAutomaticDeletions",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAutomaticDeletion"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAutomaticDeletion"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAutomaticDeletion"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/Confidentialities": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Returns a list of Confidentialities on the Form Template",
"operationId": "GetFormTemplateConfidentialities",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateConfidentialityUserRole"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateConfidentialityUserRole"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateConfidentialityUserRole"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/UnitAvailability": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Returns a list of Available Units on the Form Template",
"operationId": "GetFormTemplateUnitAvailability",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/generatePrintExample": {
"get": {
"tags": [
"FormTemplates"
],
"operationId": "GeneratePrintExample",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/createAnalyticsCustomTemplate/{templateName}": {
"post": {
"tags": [
"FormTemplates"
],
"operationId": "CreateCustomAnalyticsTemplate",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "templateName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTableFieldNameDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTableFieldNameDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTableFieldNameDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTableFieldNameDto"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_GenerateAnalyticsView | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/updateAnalyticsCustomTemplate/{templateNo}": {
"put": {
"tags": [
"FormTemplates"
],
"operationId": "UpdateCustomAnalyticsTemplate",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "templateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_GenerateAnalyticsView | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/templateCustomProperties": {
"get": {
"tags": [
"FormTemplates"
],
"summary": "Returns a list of Custom Properties on the Form Template",
"operationId": "GetFormTemplateCustomProperties",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateCustomProperty"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateCustomProperty"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateCustomProperty"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplates/{formTemplateNo}/documentcustomtags": {
"get": {
"tags": [
"FormTemplates"
],
"operationId": "GetFormTemplateDocumentCustomTags",
"parameters": [
{
"name": "formTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateTables": {
"get": {
"tags": [
"FormTemplateTables"
],
"summary": "Gets a list of Form Template Tables",
"operationId": "GetFormTemplateTables",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FormTemplateTables"
],
"summary": "Creates a new form template record",
"operationId": "CreateFormTemplateTable",
"requestBody": {
"description": "The Form Template Table Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateTables/{formTemplateTableNo}": {
"get": {
"tags": [
"FormTemplateTables"
],
"summary": "Gets a specific FormTemplateTable",
"operationId": "GetFormTemplateTable",
"parameters": [
{
"name": "formTemplateTableNo",
"in": "path",
"description": "The FormTemplateTableNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested form template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form template with the supplied Form Template Table No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"FormTemplateTables"
],
"summary": "Updates an existing FormTemplateTable",
"operationId": "UpdateFormTemplateTable",
"parameters": [
{
"name": "formTemplateTableNo",
"in": "path",
"description": "The FormTemplateTableNo of the form template to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Form Template Table DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated FormTemplateTable object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"FormTemplateTables"
],
"summary": "Deletes a form template record",
"parameters": [
{
"name": "formTemplateTableNo",
"in": "path",
"description": "The FormTemplateTableNo of the FormTemplateTable to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateTables/{formTemplateTableNo}/history": {
"get": {
"tags": [
"FormTemplateTables"
],
"summary": "Gets history for a specific FormTemplateTable",
"operationId": "GetFormTemplateTableHistory",
"parameters": [
{
"name": "formTemplateTableNo",
"in": "path",
"description": "The FormTemplateTableNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested form template",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form template with the supplied Form Template Table No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateTables/search": {
"post": {
"tags": [
"FormTemplateTables"
],
"summary": "Search for Form Template Tables\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchFormTemplateTables",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateTables/searchIndex/{formTemplateGuid}": {
"post": {
"tags": [
"FormTemplateTables"
],
"summary": "Get index of a record in a search for form templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexFormTemplateTables",
"parameters": [
{
"name": "formTemplateGuid",
"in": "path",
"description": "The form template to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateTables/searchCount": {
"post": {
"tags": [
"FormTemplateTables"
],
"summary": "Returns number of hits in a search for Form Template Tables\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountFormTemplateTables",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateTables/searchInfo": {
"get": {
"tags": [
"FormTemplateTables"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoFormTemplateTables",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/FormTemplateTables/{formTemplateTableNo}/copy": {
"get": {
"tags": [
"FormTemplateTables"
],
"summary": "Copies an existing FormTemplateTable to a new object",
"operationId": "CopyFormTemplateTable",
"parameters": [
{
"name": "formTemplateTableNo",
"in": "path",
"description": "The FormTemplateTableNo of the formTemplate to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new FormTemplateTable object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateTable"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FormTemplateTables/availableTags/{columnType}": {
"get": {
"tags": [
"FormTemplateTables"
],
"parameters": [
{
"name": "columnType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormTemplateTableColumnSetupDataType"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WordFields"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WordFields"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WordFields"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplateTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FuelTypes": {
"get": {
"tags": [
"FuelTypes"
],
"summary": "Gets a list of FuelTypes",
"operationId": "GetFuelTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FuelTypes"
],
"summary": "Creates a new FuelType record",
"operationId": "CreateFuelType",
"requestBody": {
"description": "The FuelType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FuelType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FuelTypes/{fuelTypeNo}": {
"get": {
"tags": [
"FuelTypes"
],
"summary": "Gets a specific FuelType",
"operationId": "GetFuelType",
"parameters": [
{
"name": "fuelTypeNo",
"in": "path",
"description": "The FuelTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested fuelType",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an fuelType with the supplied fuelType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"FuelTypes"
],
"summary": "Updates an existing FuelType",
"operationId": "UpdateFuelType",
"parameters": [
{
"name": "fuelTypeNo",
"in": "path",
"description": "The FuelTypeNo of the fuelType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The FuelType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated FuelType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FuelType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"FuelTypes"
],
"summary": "Deletes a FuelType record",
"parameters": [
{
"name": "fuelTypeNo",
"in": "path",
"description": "The FuelTypeNo of the FuelType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FuelType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FuelTypes/{fuelTypeNo}/history": {
"get": {
"tags": [
"FuelTypes"
],
"summary": "Gets history for a specific FuelType",
"operationId": "GetFuelTypeHistory",
"parameters": [
{
"name": "fuelTypeNo",
"in": "path",
"description": "The FuelTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested FuelType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an FuelType with the supplied FuelType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FuelType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FuelTypes/search": {
"post": {
"tags": [
"FuelTypes"
],
"summary": "Search for FuelType\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchFuelTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested fuelType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FuelTypes/searchIndex/{fuelType}": {
"post": {
"tags": [
"FuelTypes"
],
"summary": "Get index of a record in a search for fuelTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexfuelType",
"parameters": [
{
"name": "fuelTypeGuid",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "fuelType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FuelTypes/searchCount": {
"post": {
"tags": [
"FuelTypes"
],
"summary": "Returns number of hits in a search for fuelTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountFuelTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FuelTypes/searchInfo": {
"get": {
"tags": [
"FuelTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoFuelTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/FuelTypes/{fuelTypeNo}/copy": {
"get": {
"tags": [
"FuelTypes"
],
"summary": "Copies an existing FuelType to a new object",
"operationId": "CopyFuelType",
"parameters": [
{
"name": "fuelTypeNo",
"in": "path",
"description": "The FuelTypeNo of the FuelType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new FuelType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.FuelType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FuelType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FunctionAreas": {
"get": {
"tags": [
"FunctionAreas"
],
"summary": "Gets a list of FunctionAreas",
"operationId": "GetFunctionAreas",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"FunctionAreas"
],
"summary": "Creates a new functionArea record",
"operationId": "CreateFunctionArea",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FunctionArea_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FunctionAreas/{functionAreaNo}": {
"get": {
"tags": [
"FunctionAreas"
],
"summary": "Gets a specific FunctionArea",
"operationId": "GetFunctionArea",
"parameters": [
{
"name": "functionAreaNo",
"in": "path",
"description": "The FunctionAreaNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested functionArea",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an functionArea with the supplied FunctionArea No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"FunctionAreas"
],
"summary": "Updates an existing FunctionArea",
"operationId": "UpdateFunctionArea",
"parameters": [
{
"name": "functionAreaNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FunctionArea_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"FunctionAreas"
],
"summary": "Deletes a functionArea record",
"parameters": [
{
"name": "functionAreaNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FunctionArea_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FunctionAreas/{functionAreaNo}/history": {
"get": {
"tags": [
"FunctionAreas"
],
"summary": "Gets history for a specific FunctionArea",
"operationId": "GetFunctionAreaHistory",
"parameters": [
{
"name": "functionAreaNo",
"in": "path",
"description": "The FunctionAreaNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested functionArea",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an functionArea with the supplied FunctionArea No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FunctionArea_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FunctionAreas/search": {
"post": {
"tags": [
"FunctionAreas"
],
"summary": "Search for FunctionAreas\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchFunctionAreas",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FunctionAreas/searchCount": {
"post": {
"tags": [
"FunctionAreas"
],
"summary": "Returns number of hits in a search for FunctionAreas\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountFunctionAreas",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FunctionAreas/searchIndex/{functionAreaGuid}": {
"post": {
"tags": [
"FunctionAreas"
],
"summary": "Get index of a record in a search for functionArea\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexFunctionAreas",
"parameters": [
{
"name": "functionAreaGuid",
"in": "path",
"description": "The functionArea to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FunctionAreas/searchInfo": {
"get": {
"tags": [
"FunctionAreas"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoFunctionAreas",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/FunctionAreas/{functionAreaNo}/copy": {
"get": {
"tags": [
"FunctionAreas"
],
"summary": "Copies an existing FunctionArea to a new object",
"operationId": "CopyFunctionArea",
"parameters": [
{
"name": "functionAreaNo",
"in": "path",
"description": "The FunctionAreaNo of the functionArea to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new FunctionArea object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FunctionArea_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FunctionAreas/{functionAreaNo}/Units": {
"get": {
"tags": [
"FunctionAreas"
],
"summary": "Returns a list of Units on the Function Area",
"operationId": "GetFunctionAreaUnits",
"parameters": [
{
"name": "functionAreaNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionAreaUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionAreaUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionAreaUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/FunctionAreas/{functionAreaNo}/Units/{unitNo}": {
"get": {
"tags": [
"FunctionAreas"
],
"summary": "Returns a specific Unit on the Function Area",
"operationId": "GetFunctionAreaUnit",
"parameters": [
{
"name": "functionAreaNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GarbageReceivers": {
"get": {
"tags": [
"GarbageReceivers"
],
"summary": "Gets a list of GarbageReceivers",
"operationId": "GetGarbageReceivers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"GarbageReceivers"
],
"summary": "Creates a new GarbageReceiver record",
"operationId": "CreateGarbageReceiver",
"requestBody": {
"description": "The GarbageReceiver Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GarbageReceivers/{GarbageReceiverNo}": {
"get": {
"tags": [
"GarbageReceivers"
],
"summary": "Gets a specific GarbageReceiver",
"operationId": "GetGarbageReceiver",
"parameters": [
{
"name": "GarbageReceiverNo",
"in": "path",
"description": "The GarbageReceiverNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested GarbageReceiver",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an GarbageReceiver with the supplied GarbageReceiver No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"GarbageReceivers"
],
"summary": "Updates an existing GarbageReceiver",
"operationId": "UpdateGarbageReceiver",
"parameters": [
{
"name": "GarbageReceiverNo",
"in": "path",
"description": "The GarbageReceiverNo of the GarbageReceiver to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The GarbageReceiver DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated GarbageReceiver object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GarbageReceivers/{GarbageReceiverNo}/history": {
"get": {
"tags": [
"GarbageReceivers"
],
"summary": "Gets history for a specific GarbageReceiver",
"operationId": "GetGarbageReceiverHistory",
"parameters": [
{
"name": "GarbageReceiverNo",
"in": "path",
"description": "The GarbageReceiverNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested GarbageReceiver",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an GarbageReceiver with the supplied GarbageReceiver No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GrbOperation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GarbageReceivers/search": {
"post": {
"tags": [
"GarbageReceivers"
],
"summary": "Search for GarbageReceivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchGarbageReceivers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested GarbageReceiver",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GarbageReceivers/searchIndex/{GarbageReceiverGuid}": {
"post": {
"tags": [
"GarbageReceivers"
],
"summary": "Get index of a record in a search for GarbageReceivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexGarbageReceivers",
"parameters": [
{
"name": "GarbageReceiverGuid",
"in": "path",
"description": "The GarbageReceiver to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GarbageReceivers/searchCount": {
"post": {
"tags": [
"GarbageReceivers"
],
"summary": "Returns number of hits in a search for GarbageReceivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountGarbageReceivers",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GarbageReceivers/searchInfo": {
"get": {
"tags": [
"GarbageReceivers"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoGarbageReceivers",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/GarbageReceivers/{GarbageReceiverNo}/copy": {
"get": {
"tags": [
"GarbageReceivers"
],
"summary": "Copies an existing GarbageReceiver to a new object",
"operationId": "CopyGarbageReceiver",
"parameters": [
{
"name": "GarbageReceiverNo",
"in": "path",
"description": "The GarbageReceiverNo of the GarbageReceiver to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new GarbageReceiver object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GarbageReceivers/{GarbageReceiverNo}/Documents": {
"get": {
"tags": [
"GarbageReceivers"
],
"summary": "Returns a list of Documents on the GarbageReceiver",
"operationId": "GetGarbageReceiverDocumentLinks",
"parameters": [
{
"name": "GarbageReceiverNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GarbageReceiverDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GarbageReceiverDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GarbageReceiverDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GarbageReceivers/{GarbageReceiverNo}/Documents/{documentNo}": {
"get": {
"tags": [
"GarbageReceivers"
],
"summary": "Returns a specific Document on the GarbageReceiver",
"operationId": "GetGarbageReceiverDocumentLink",
"parameters": [
{
"name": "GarbageReceiverNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GarbageReceiverDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GarbageReceiverDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GarbageReceiverDocument"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Gets a list of GrbOperations",
"operationId": "GetGrbOperations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"GrbOperations"
],
"summary": "Creates a new GrbOperation",
"operationId": "CreateGrbOperation",
"requestBody": {
"description": "The GrbOperation wrapper Object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationCreate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationCreate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationCreate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationCreate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/{operationNo}": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Gets a specific GrbOperation",
"operationId": "GetGrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested GrbOperation",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an GrbOperation with the supplied GrbOperation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"GrbOperations"
],
"summary": "Updates an existing GrbOperation",
"operationId": "UpdateGrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the GrbOperation to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The GrbOperation DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated GrbOperation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"GrbOperations"
],
"summary": "Deletes a GrbOperation record",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the GrbOperation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GrbOperation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/{operationNo}/history": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Gets history for a specific GrbOperation",
"operationId": "GetGrbOperationHistory",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested GrbOperation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an GrbOperation with the supplied GrbOperation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GrbOperation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/search": {
"post": {
"tags": [
"GrbOperations"
],
"summary": "Search for GrbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchGrbOperations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested GrbOperation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/searchIndex/{GrbOperationGuid}": {
"post": {
"tags": [
"GrbOperations"
],
"summary": "Get index of a record in a search for GrbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexGrbOperations",
"parameters": [
{
"name": "GrbOperationGuid",
"in": "path",
"description": "The GrbOperation to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/searchCount": {
"post": {
"tags": [
"GrbOperations"
],
"summary": "Returns number of hits in a search for GrbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountGrbOperations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/searchInfo": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoGrbOperations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/GrbOperations/{operationNo}/copy": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Copies an existing GrbOperation to a new object",
"operationId": "CopyGrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the GrbOperation to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new GrbOperation object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/{operationNo}/Documents": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Returns a list of Documents on the GrbOperation",
"operationId": "GetGrbOperationDocumentLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GrbOperationDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GrbOperationDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GrbOperationDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/{operationNo}/Documents/{documentNo}": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Returns a specific Document on the Certificate",
"operationId": "GetGrbOperationDocumentLink",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GrbOperationDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GrbOperationDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GrbOperationDocument"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/{operationNo}/DischargedProducts": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Returns a list of Discharged Products for a specific GrbOperation",
"operationId": "GetDischargedProducts",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The Operation No to fetch items for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Discharged Products for the Operation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DischargedProductView"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DischargedProductView"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DischargedProductView"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/{operationNo}/GrbOperationEnvironmentalItems": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Returns a list of Env Items for a specific GrbOperation",
"operationId": "GetGrbOperationEnvironmentalItems",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The Operation No to fetch items for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Discharged Products for the Operation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.Views.GrbOperationEnvironmentalItemView"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.Views.GrbOperationEnvironmentalItemView"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.Views.GrbOperationEnvironmentalItemView"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/GetPrintoutForGrbOperations": {
"post": {
"tags": [
"GrbOperations"
],
"summary": "Gets a printout, based on a list of operationNo's",
"operationId": "GetPrintoutForGrbOperations",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/GetLatestGrbOperationEndTime": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Get the latest operation end time",
"operationId": "GetLatestGrbOperationEndTime",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "date-time"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/{operationNo}/Signers": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Returns a list of Signers on the GrbOperation",
"operationId": "GetGrbOperationSignersLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationSigner"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationSigner"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationSigner"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/GetPrintoutTableDataForGrbOperations": {
"post": {
"tags": [
"GrbOperations"
],
"summary": "Gets a printout, based on a list of operationNo's",
"operationId": "GetPrintoutTableDataForGrbOperations",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/{operationNo}/GarbageReceivers": {
"get": {
"tags": [
"GrbOperations"
],
"summary": "Returns a list of GarbageReceivers on the GrbOperation",
"operationId": "GetGrbOperationGarbageReceiverLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationGarbageReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationGarbageReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationGarbageReceiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GrbOperations/sign": {
"post": {
"tags": [
"GrbOperations"
],
"summary": "Signs list of Operations",
"operationId": "SignGrbOperations",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated GrbOperation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GridColumnLayouts/{gridKey}": {
"get": {
"tags": [
"GridColumnLayouts"
],
"summary": "Gets a specific Grid Column Layout",
"operationId": "GetGridColumnLayout",
"parameters": [
{
"name": "gridKey",
"in": "path",
"description": "The gridKey to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested grid column layout",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a grid column layout with the supplied Grid Key cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"GridColumnLayouts"
],
"summary": "Updates an existing GridColumnLayout",
"operationId": "UpdateGridColumnLayout",
"parameters": [
{
"name": "gridKey",
"in": "path",
"description": "The gridKey of the gridColumnLayout to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The GridColumnLayout DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Certificate object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"GridColumnLayouts"
],
"summary": "Deletes a address record",
"operationId": "DeleteGridColumnLayout",
"parameters": [
{
"name": "gridKey",
"in": "path",
"description": "The gridKey of the GridColumnLayout to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GridColumnLayouts": {
"post": {
"tags": [
"GridColumnLayouts"
],
"summary": "Creates a new GridColumnLayout record",
"operationId": "CreateGridColumnLayout",
"requestBody": {
"description": "The GridColumnLayout Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.GridColumnLayout"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GridLayouts": {
"get": {
"tags": [
"GridLayouts"
],
"summary": "Gets a list of SavedGridLayouts",
"operationId": "GetSavedGridLayouts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"GridLayouts"
],
"summary": "Creates a new savedgridlayout record",
"operationId": "CreateSavedGridLayout",
"requestBody": {
"description": "The SavedGridLayout Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GridLayouts/{guid}": {
"get": {
"tags": [
"GridLayouts"
],
"summary": "Gets a specific SavedGridLayout",
"operationId": "GetSavedGridLayout",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The SavedGridLayoutNo to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested savedgridlayout",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an savedgridlayout with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"GridLayouts"
],
"summary": "Updates an existing SavedGridLayout",
"operationId": "UpdateSavedGridLayout",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid of the savedgridlayout to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The SavedGridLayout DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated SavedGridLayout object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"GridLayouts"
],
"summary": "Deletes a savedgridlayout record",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The Guid of the SavedGridLayout to delete",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GridLayouts/{guid}/history": {
"get": {
"tags": [
"GridLayouts"
],
"summary": "Gets history for a specific SavedGridLayout",
"operationId": "GetSavedGridLayoutHistory",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The SavedGridLayoutNo to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested SavedGridLayout",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a SavedGridLayout with the supplied guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GridLayouts/searchIndex/{savedGridlayoutGuid}": {
"post": {
"tags": [
"GridLayouts"
],
"summary": "Get index of a record in a search for gridlayout\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSavedGridLayouts",
"parameters": [
{
"name": "savedGridlayoutGuid",
"in": "path",
"description": "The savedGridLayout to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GridLayouts/search": {
"post": {
"tags": [
"GridLayouts"
],
"summary": "Search for SavedGridLayouts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSavedGridLayouts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested savedgridlayout",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayout"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GridLayouts/searchCount": {
"post": {
"tags": [
"GridLayouts"
],
"summary": "Returns number of hits in a search for SavedGridLayouts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSavedGridLayouts",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GridLayouts/searchInfo": {
"get": {
"tags": [
"GridLayouts"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSavedGridLayouts",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/GridLayouts/{guid}/users": {
"get": {
"tags": [
"GridLayouts"
],
"summary": "Fetches all users attached to the SavedGridLayout",
"operationId": "GetSavedGridLayoutUsers",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid to fetch users for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the user for the SavedGridLayout",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GridLayouts/{guid}/users/{userNo}": {
"get": {
"tags": [
"GridLayouts"
],
"summary": "Fetches a specific user attached to the SavedGridLayout",
"operationId": "GetSavedGridLayoutUser",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The Guid to fetch users for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "userNo",
"in": "path",
"description": "The user no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the specific SavedGridLayoutUser for the SavedGridLayout",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEventSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GroupCodes": {
"get": {
"tags": [
"GroupCodes"
],
"summary": "Gets a list of Group Codes",
"operationId": "GetGroupCodes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GroupCodes/{ID}": {
"get": {
"tags": [
"GroupCodes"
],
"summary": "Gets a specific Group Code",
"operationId": "GetGroupCode",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "the ID to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested group code",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a group code with the supplied ID cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GroupCodes/{ID}/history": {
"get": {
"tags": [
"GroupCodes"
],
"summary": "Gets history for a specific Group Code",
"operationId": "GetGroupCodeHistory",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The ID to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested group code",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a group code with the supplied ID cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GroupCode_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GroupCodes/search": {
"post": {
"tags": [
"GroupCodes"
],
"summary": "Search for Group Codes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchGroupCodes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.GroupCode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GroupCodes/searchCount": {
"post": {
"tags": [
"GroupCodes"
],
"summary": "Returns number of hits in a search for Group Codes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountGroupCodes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GroupCodes/searchIndex/{ID}": {
"post": {
"tags": [
"GroupCodes"
],
"summary": "Get index of a record in a search for Group Codes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexGroupCodes",
"parameters": [
{
"name": "groupCodeGuid",
"in": "query",
"description": "The group code to get index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "ID",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/GroupCodes/searchInfo": {
"get": {
"tags": [
"GroupCodes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoGroupCodes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ImInvoices": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Gets a list of ImInvoices",
"operationId": "GetInvoices",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ImInvoices"
],
"summary": "Creates a new invoice record",
"operationId": "CreateImInvoice",
"requestBody": {
"description": "The ImInvoice Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Gets a specific ImInvoice",
"operationId": "GetImInvoice",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The InvoiceNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested ImInvoice",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ImInvoice with the supplied Invoice No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/calculatedFields": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Gets a specific ImInvoice",
"operationId": "GetImInvoiceCalculatedFields",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The InvoiceNo to get calculated fields for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested ImInvoice",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ImInvoice with the supplied Invoice No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/history": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Gets history for a specific ImInvoice",
"operationId": "GetImInvoiceHistory",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The InvoiceNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested ImInvoice",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ImInvoice with the supplied Invoice No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/search": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Search for ImInvoices\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchImInvoices",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/searchIndex/{invoiceGuid}": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Get index of a record in a search for ImInvoice\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexImInvoices",
"parameters": [
{
"name": "invoiceGuid",
"in": "path",
"description": "The ImInvoice to find index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/searchCount": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Returns number of hits in a search for ImInvoices\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountImInvoices",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/searchInfo": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoImInvoices",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ImInvoices/build": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Builds a record and returns it without persisting it",
"operationId": "BuildInvoice",
"requestBody": {
"description": "The DTO containing user choices for building invoice",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceCreateSelection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceCreateSelection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceCreateSelection"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceCreateSelection"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{imInvoiceNo}": {
"put": {
"tags": [
"ImInvoices"
],
"summary": "Updates an existing Invoice",
"operationId": "UpdateImInvoice",
"parameters": [
{
"name": "imInvoiceNo",
"in": "path",
"description": "The imInvoiceNo of the imInvoice to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ImInvoice DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ImInvoice object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/positions": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Gets a list of ImInvoice positions",
"operationId": "GetImInvoicePositions",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The Invoice No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/positions/calculatedFields": {
"get": {
"tags": [
"ImInvoices"
],
"operationId": "GetInvoicePositionsCalculatedFields",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/positions/{positionNo}": {
"get": {
"tags": [
"ImInvoices"
],
"operationId": "GetInvoicePosition",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "positionNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/positions/{positionNo}/calculatedFields": {
"get": {
"tags": [
"ImInvoices"
],
"operationId": "GetInvoicePositionCalculatedFields",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "positionNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/approval": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Gets a list of ImInvoice Approvers",
"operationId": "GetImInvoiceApprovers",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The Invoice No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprover"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprover"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprover"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/approveFromApprovalWeb": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Approve Invoice",
"operationId": "ApproveInvoiceFromApprovalWeb",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The InvoiceNo to approve",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Approve | Function |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/rejectFromApprovalWeb": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Reject Invoice",
"operationId": "RejectInvoiceFromApprovalWeb",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The InvoiceNo to reject",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The info needed to reject the invoice",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprovalInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprovalInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprovalInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprovalInfo"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Reject | Function |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/UpdateExternalPaymentInfo": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Updates external payment information on an Invoice",
"operationId": "UpdateExternalPaymentInfo",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The InvoiceNo of the invoice to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The external payment information to set",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceExternalPaymentInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceExternalPaymentInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceExternalPaymentInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceExternalPaymentInfo"
}
}
}
},
"responses": {
"200": {
"description": "If the external payment info was updated"
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an invoice with the supplied Invoice No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/documents/primary": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Returns a specific job document",
"operationId": "GetPrimaryInvoiceDocument",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The Invoice No",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the primary invoice document for the invoice"
},
"404": {
"description": "If a primary invoice document for the invoice cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/purchaseOrders": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Returns a list of Purchase Orders used on the Invoice",
"operationId": "GetImInvoicePurchaseOrders",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The InvoiceNo to fetch documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the purchase orders for the ImInvoice",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePurchaseOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePurchaseOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePurchaseOrder"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/responses": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Gets a list of ImInvoice Responses",
"operationId": "GetImInvoiceResponses",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The Invoice No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ImInvoices"
],
"summary": "Add response",
"operationId": "AddImInvoiceResponse",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The invoiceNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ImInvoiceResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/responses/count": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Returns number of ImInvoiceResponses for invoiceNo",
"operationId": "CountImInvoiceResponses",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The InvoiceNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/additionalCosts": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Gets a list of ImInvoice additional costs",
"operationId": "GetImInvoiceAdditionalCosts",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The Invoice No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceAdditionalCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceAdditionalCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceAdditionalCost"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/documents": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Gets a list of ImInvoice documents",
"operationId": "GetImInvoiceDocuments",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "The Invoice No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceDocument2Link"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceDocument2Link"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceDocument2Link"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/purchaseordertotals": {
"get": {
"tags": [
"ImInvoices"
],
"operationId": "GetImInvoicePurchaseOrderTotals",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceTotal"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceTotal"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceTotal"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/relatedinvoices": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Gets a list of related Invoices",
"operationId": "GetImInvoiceRelatedInvoices",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/canBeReversed": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Check if current user can reverse invoice",
"operationId": "CanBeReversed",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Reversal | Function |
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/createReversal": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Create reversed ImInvoice",
"operationId": "CreateReversal",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceReversal"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceReversal"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceReversal"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceReversal"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Reversal | Function |
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/canBeAutomatched": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Check if current invoice can be automatched",
"operationId": "CanBeAutomatched",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/automatchInvoice": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Automatch current invoice",
"operationId": "AutoMatch",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/canBePutOnHold": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Check if current invoice can be put on hold by the current user",
"operationId": "CanBePutOnHold",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/putOnHold": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Put the current invoice on hold",
"operationId": "PutOnHold",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/canBeResumed": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Checks if the invoice can be taken out of hold/resumed by the current user",
"operationId": "CanBeResumed",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/resume": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Resumes the invoice",
"operationId": "Resume",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/canReturnToDraft": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Check if Invoice can be returned to draft by current user.",
"operationId": "CanReturnToDraft",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/returnToDraft": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Returns invoice to draft",
"operationId": "ReturnToDrafr",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceReturnToDraft"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceReturnToDraft"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceReturnToDraft"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceReturnToDraft"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/canBeRejected": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Check if Invoice can be rejected by currentuser",
"operationId": "CanBeRejected",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/reject": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Rejects the current invoice",
"operationId": "Reject",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprovalInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprovalInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprovalInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprovalInfo"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/addDocument": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Add Document to a closed invoice",
"operationId": "AddDocumentToClosedInvoice",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "list of documentNos to add",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/canBeMovedToAnotherUnit": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Check if Invoice can be moved to another unit.",
"operationId": "CanBeMovedToAnotherUnit",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/moveToAnotherUnit": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Move Invoice to another Unit",
"operationId": "MoveToAnotherUnit",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceMoveToUnitResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceMoveToUnitResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceMoveToUnitResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/canResponsibleBeChanged": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Check if responsible of invoice can be changed.",
"operationId": "canResponsibleBeChanged",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/changeResponsible": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Change responsible User on Invoice",
"operationId": "changeResponsible",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Arguments for method",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.InvoiceChangeResponsibleArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.InvoiceChangeResponsibleArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.InvoiceChangeResponsibleArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.InvoiceChangeResponsibleArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.InvoiceChangeResponsibleResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.InvoiceChangeResponsibleResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.InvoiceChangeResponsibleResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/canBeForwardedForApproval": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Check if Invoice can be forwarded for approval",
"operationId": "CanBeForwardedForApproval",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/PrepareForwardForApproval": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Check what issues may occur for invoice when forwarding for approval",
"operationId": "PrepareForForwardForApproval",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceForwardForApprovalResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceForwardForApprovalResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceForwardForApprovalResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/ExecuteForwardForApproval": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Execute forward for approval for one or more invoices",
"operationId": "ExecuteForwardForApproval",
"requestBody": {
"description": "Contains invoice numbers and user arguments",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecuteForwardForApprovalRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecuteForwardForApprovalRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecuteForwardForApprovalRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecuteForwardForApprovalRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceForwardForApprovalResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceForwardForApprovalResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceForwardForApprovalResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/CanBeApproved": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Check if Invoice can be approved",
"operationId": "CanBeApproved",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/PrepareApprove": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Check what issues may occur for invoice when forwarding for approval",
"operationId": "PrepareApprove",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/ExecuteApprove": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Execute approve for one or more invoices",
"operationId": "ExecuteApprove",
"requestBody": {
"description": "Contains invoice numbers and user arguments",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecuteApproveRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecuteApproveRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecuteApproveRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecuteApproveRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/CanBePreApproved": {
"get": {
"tags": [
"ImInvoices"
],
"summary": "Check if Invoice can be pre approved",
"operationId": "CanBePreApproved",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/PreparePreApprove": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Check what issues may occur for invoice when Pre Approving",
"operationId": "PreparePreApprove",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/ExecutePreApprove": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Execute pre approve for one or more invoices",
"operationId": "ExecutePreApprove",
"requestBody": {
"description": "Contains invoice numbers and user arguments",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecutePreApproveRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecutePreApproveRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecutePreApproveRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ExecutePreApproveRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ImInvoices/{invoiceNo}/changeApprovalSetup": {
"post": {
"tags": [
"ImInvoices"
],
"summary": "Change approval setup.",
"operationId": "ChangeApprovalSetup",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_AllowChangeApprovalFlow | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionAreas": {
"get": {
"tags": [
"InspectionAreas"
],
"summary": "Gets a list of Inspection Areas",
"operationId": "GetInspectionAreas",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionAreas/{inspectionAreaNo}": {
"get": {
"tags": [
"InspectionAreas"
],
"summary": "Gets a specific Inspection Area",
"operationId": "GetInspectionArea",
"parameters": [
{
"name": "inspectionAreaNo",
"in": "path",
"description": "the inspectionAreaNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested inspection area",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an inspection area with the supplied Inspection Area No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionAreas/{inspectionAreaNo}/history": {
"get": {
"tags": [
"InspectionAreas"
],
"summary": "Gets history for a specific Inspection Area",
"operationId": "GetInspectionAreaHistory",
"parameters": [
{
"name": "inspectionAreaNo",
"in": "path",
"description": "The inspectionAreaNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested inspection area",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an inspection area with the supplied Inspection Area No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Metadata_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionAreas/search": {
"post": {
"tags": [
"InspectionAreas"
],
"summary": "Search for Inspection Areas\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchInspectionAreas",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionArea"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionAreas/searchCount": {
"post": {
"tags": [
"InspectionAreas"
],
"summary": "Returns number of hits in a search for Inspection Areas\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountInspectionAreas",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionAreas/searchIndex/{inspectionAreaNo}": {
"post": {
"tags": [
"InspectionAreas"
],
"summary": "Get index of a record in a search for Inspection Areas\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexInspectionAreas",
"parameters": [
{
"name": "inspectionAreaGuid",
"in": "query",
"description": "The inspection area to get index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "inspectionAreaNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionAreas/searchInfo": {
"get": {
"tags": [
"InspectionAreas"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoInspectionAreas",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/InspectionJobHistories": {
"get": {
"tags": [
"InspectionJobHistories"
],
"summary": "Gets a list of InspectionJobHistories",
"operationId": "GetInspectionJobHistories",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJobHistory | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobHistories/{inspectionJobHistoryGuid}": {
"get": {
"tags": [
"InspectionJobHistories"
],
"summary": "Gets a specific InspectionJobHistory",
"operationId": "GetInspectionJobHistory",
"parameters": [
{
"name": "inspectionJobHistoryGuid",
"in": "path",
"description": "The guid of the InspectionJobHistory to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested inspectionJobHistory",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a InspectionJobHistory with the supplied InspectionJobHistory No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJobHistory | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"InspectionJobHistories"
],
"summary": "Updates an existing InspectionJobHistory",
"operationId": "UpdateInspectionJobHistory",
"parameters": [
{
"name": "inspectionJobHistoryGuid",
"in": "path",
"description": "The InspectionJobHistory guid of the InspectionJobHistory to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The JobHistory DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated InspectionJobHistory object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJobHistory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobHistories/{inspectionJobHistoryGuid}/history": {
"get": {
"tags": [
"InspectionJobHistories"
],
"summary": "Gets history for a specific InspectionJobHistory",
"operationId": "GetInspectionJobHistoryHistory",
"parameters": [
{
"name": "inspectionJobHistoryGuid",
"in": "path",
"description": "The InspectionJobHistoryGuid to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobHistory",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobHistory with the supplied JobHistory No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJobHistory_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobHistories/search": {
"post": {
"tags": [
"InspectionJobHistories"
],
"summary": "Search for InspectionJobHistories\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchInspectionJobHistories",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested inspectionJobHistory",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJobHistory | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobHistories/searchCount": {
"post": {
"tags": [
"InspectionJobHistories"
],
"summary": "Returns number of hits in a search for InspectionJobHistories\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountInspectionJobHistories",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJobHistory | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobHistories/searchInfo": {
"get": {
"tags": [
"InspectionJobHistories"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoInspectionJobHistories",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/InspectionJobHistories/searchIndex/{inspectionJobHistoryGuid}": {
"post": {
"tags": [
"InspectionJobHistories"
],
"summary": "Get index of a record in a search for inspection job histories\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexInspectionJobHistories",
"parameters": [
{
"name": "inspectionJobHistoryGuid",
"in": "path",
"description": "The job history to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJobHistory | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobHistories/appSubmit": {
"post": {
"tags": [
"InspectionJobHistories"
],
"summary": "Submits a InspectionJobHistory from App",
"operationId": "InspectionJobHistoryAppSubmit",
"requestBody": {
"description": "The inspectionJobHistory to submit",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJobHistory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobs": {
"get": {
"tags": [
"InspectionJobs"
],
"summary": "Gets a list of Inspection Jobs",
"operationId": "GetInspectionJobs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJob | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobs/{inspectionJobNo}": {
"get": {
"tags": [
"InspectionJobs"
],
"summary": "Gets a specific Inspection Job",
"operationId": "GetInspectionJob",
"parameters": [
{
"name": "inspectionJobNo",
"in": "path",
"description": "the InspectionJobNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested inspection job",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an inspection job with the supplied InspectionJobNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJob | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobs/{inspectionJobNo}/history": {
"get": {
"tags": [
"InspectionJobs"
],
"summary": "Gets history for a specific Inspection Job",
"operationId": "GetHistoryForInspectionJob",
"parameters": [
{
"name": "inspectionJobNo",
"in": "path",
"description": "The InspectionJobNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested inspection job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an inspection job with the supplied InspectionJobNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJob_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobs/search": {
"post": {
"tags": [
"InspectionJobs"
],
"summary": "Search for Inspection Jobs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchInspectionJobs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJob | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobs/searchCount": {
"post": {
"tags": [
"InspectionJobs"
],
"summary": "Returns number of hits in a search for Inspection Jobs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountInspectionJobs",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJob | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobs/searchIndex/{inspectionJobNo}": {
"post": {
"tags": [
"InspectionJobs"
],
"summary": "Get index of a record in a search for Inspection Jobs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexInspectionJobs",
"parameters": [
{
"name": "inspectionJobGuid",
"in": "query",
"description": "The InspectionJobNo to get index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "inspectionJobNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJob | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobs/searchInfo": {
"get": {
"tags": [
"InspectionJobs"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoInspectionJobs",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/InspectionJobs/{inspectionJobNo}/inspectionAreas": {
"get": {
"tags": [
"InspectionJobs"
],
"summary": "Fetches all Inspection Areas attached to the Inspection Job",
"operationId": "GetInspectionJobInspectionAreas",
"parameters": [
{
"name": "inspectionJobNo",
"in": "path",
"description": "The InspectionJobNo to fetch InspectionAreas for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the InspectionAreas for the InspectionJob",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobInspectionArea"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobInspectionArea"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobInspectionArea"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJob | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionJobs/{inspectionJobNo}/inspectionAreas/{inspectionAreaNo}": {
"get": {
"tags": [
"InspectionJobs"
],
"summary": "Fetches a specific Inspection Area attached to the Inspection Job",
"operationId": "GetInspectionJobInspectionArea",
"parameters": [
{
"name": "inspectionJobNo",
"in": "path",
"description": "The InspectionJobNo to fetch InspectionAreas for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "inspectionAreaNo",
"in": "path",
"description": "The InspectionAreaNo to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the InspectionArea for the InspectionJob",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobInspectionArea"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobInspectionArea"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobInspectionArea"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionJob | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists": {
"get": {
"tags": [
"InspectionLists"
],
"summary": "Gets a list of Inspection Lists",
"operationId": "GetInspectionLists",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/{inspectionListNo}": {
"get": {
"tags": [
"InspectionLists"
],
"summary": "Gets a specific Inspection List",
"operationId": "GetInspectionList",
"parameters": [
{
"name": "inspectionListNo",
"in": "path",
"description": "the inspectionListNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested inspection list",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJob"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an inspection list with the supplied InspectionListNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/{inspectionListNo}/history": {
"get": {
"tags": [
"InspectionLists"
],
"summary": "Gets history for a specific Inspection List",
"operationId": "GetInspectionListHistory",
"parameters": [
{
"name": "inspectionListNo",
"in": "path",
"description": "The inspectionListNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested inspection list",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an inspection list with the supplied InspectionListNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/search": {
"post": {
"tags": [
"InspectionLists"
],
"summary": "Search for Inspection Lists\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchInspectionLists",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/searchCount": {
"post": {
"tags": [
"InspectionLists"
],
"summary": "Returns number of hits in a search for Inspection Lists\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountInspectionLists",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/searchIndex/{inspectionListNo}": {
"post": {
"tags": [
"InspectionLists"
],
"summary": "Get index of a record in a search for Inspection Lists\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexInspectionLists",
"parameters": [
{
"name": "inspectionListGuid",
"in": "query",
"description": "The inspectionListNo to get index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "inspectionListNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/appSubmit": {
"post": {
"tags": [
"InspectionLists"
],
"summary": "Receive/Update InspectionList",
"operationId": "InspectionAppSubmit",
"requestBody": {
"description": "The InspectionList to Receive",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionList"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
| InspectionList_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/searchInfo": {
"get": {
"tags": [
"InspectionLists"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoInspectionLists",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/InspectionLists/{inspectionListNo}/inspectionJobHistories": {
"get": {
"tags": [
"InspectionLists"
],
"summary": "Fetches all InspectionJobHistories attached to the InspectionList",
"operationId": "GetInspectionListInspectionJobHistories",
"parameters": [
{
"name": "inspectionListNo",
"in": "path",
"description": "The InspectionListNo to fetch InspectionJobHistories for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the InspectionJobHistories for the InspectionList",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/{inspectionListNo}/inspectionJobHistories/{inspectionJobNo}": {
"get": {
"tags": [
"InspectionLists"
],
"summary": "Fetches a specific InspectionJobHistory attached to the InspectionList",
"operationId": "GetInspectionListInspectionJobHistory",
"parameters": [
{
"name": "inspectionListNo",
"in": "path",
"description": "The InspectionListNo to fetch Surveyors for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "inspectionJobNo",
"in": "path",
"description": "The InspectionJobNo to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the InspectionJobHistory for the InspectionList",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/{inspectionListNo}/surveyors": {
"get": {
"tags": [
"InspectionLists"
],
"summary": "Fetches all Surveyors attached to the InspectionList",
"operationId": "GetInspectionListSurveyors",
"parameters": [
{
"name": "inspectionListNo",
"in": "path",
"description": "The InspectionListNo to fetch Surveyors for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Surveyors for the InspectionList",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListSurveyor"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListSurveyor"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListSurveyor"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/{inspectionListNo}/surveyors/{surveyorNo}": {
"get": {
"tags": [
"InspectionLists"
],
"summary": "Fetches a specific Surveyor attached to the InspectionList",
"operationId": "GetInspectionListSurveyor",
"parameters": [
{
"name": "inspectionListNo",
"in": "path",
"description": "The Inspection List to fetch Surveyors for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "surveyorNo",
"in": "path",
"description": "The Surveyor No to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Surveyor for the Inspection List",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListSurveyor"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListSurveyor"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListSurveyor"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/{inspectionListNo}/ratingTypeValues": {
"get": {
"tags": [
"InspectionLists"
],
"summary": "Fetches all RatingTypeValues attached to the InspectionList",
"operationId": "GetInspectionListRatingTypeValues",
"parameters": [
{
"name": "inspectionListNo",
"in": "path",
"description": "The InspectionListNo to fetch Surveyors for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the RatingTypeValues for the InspectionList",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListActualRatingTypeValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListActualRatingTypeValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListActualRatingTypeValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionLists/{inspectionListNo}/ratingTypeValues/{value}": {
"get": {
"tags": [
"InspectionLists"
],
"summary": "Fetches a specific RatingTypeValue attached to the InspectionList",
"operationId": "GetInspectionListRatingTypeValue",
"parameters": [
{
"name": "inspectionListNo",
"in": "path",
"description": "The Inspection List to fetch Surveyors for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "value",
"in": "path",
"description": "The value to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Surveyor for the Inspection List",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListSurveyor"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListSurveyor"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListSurveyor"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionListTypes": {
"get": {
"tags": [
"InspectionListTypes"
],
"summary": "Gets a list of Inspection List Types",
"operationId": "GetInspectionListTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionListType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionListTypes/{inspectionListTypeNo}": {
"get": {
"tags": [
"InspectionListTypes"
],
"summary": "Gets a specific Inspection List Type",
"operationId": "GetInspectionListType",
"parameters": [
{
"name": "inspectionListTypeNo",
"in": "path",
"description": "the inspectionListTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested inspection list type",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a inspection list type with the supplied Inspection List Type No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionListType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionListTypes/{inspectionListTypeNo}/history": {
"get": {
"tags": [
"InspectionListTypes"
],
"summary": "Gets history for a specific Inspection List Type",
"operationId": "GetInspectionListTypeHistory",
"parameters": [
{
"name": "inspectionListTypeNo",
"in": "path",
"description": "The inspectionListTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested inspection list type",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a inspection list type with the supplied Inspection List Type No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionListType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionListTypes/search": {
"post": {
"tags": [
"InspectionListTypes"
],
"summary": "Search for Inspection List Types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchInspectionListTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionListType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionListTypes/searchCount": {
"post": {
"tags": [
"InspectionListTypes"
],
"summary": "Returns number of hits in a search for Inspection List Types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountInspectionListTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionListType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionListTypes/searchIndex/{inspectionListTypeNo}": {
"post": {
"tags": [
"InspectionListTypes"
],
"summary": "Get index of a record in a search for Inspection List Types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexInspectionListTypes",
"parameters": [
{
"name": "inspectionListTypeGuid",
"in": "query",
"description": "The inspection list type to get index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "inspectionListTypeNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| InspectionListType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InspectionListTypes/searchInfo": {
"get": {
"tags": [
"InspectionListTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoInspectionListTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/InvoiceDocuments": {
"get": {
"tags": [
"InvoiceDocuments"
],
"summary": "Gets a list of InvoiceDocuments",
"operationId": "GetInvoiceDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"InvoiceDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateInvoiceDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/{documentNo}": {
"get": {
"tags": [
"InvoiceDocuments"
],
"summary": "Gets a specific InvoiceDocument",
"operationId": "GetInvoiceDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"InvoiceDocuments"
],
"summary": "Updates an existing Document",
"operationId": "UpdateInvoiceDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"InvoiceDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"InvoiceDocuments"
],
"summary": "Get index of a record in a search for InvoiceDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexInvoiceDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/{documentNo}/history": {
"get": {
"tags": [
"InvoiceDocuments"
],
"summary": "Gets history for a specific InvoiceDocument",
"operationId": "GetInvoiceDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/search": {
"post": {
"tags": [
"InvoiceDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchInvoiceDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/searchCount": {
"post": {
"tags": [
"InvoiceDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountInvoiceDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/searchInfo": {
"get": {
"tags": [
"InvoiceDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoInvoiceDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/InvoiceDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"InvoiceDocuments"
],
"summary": "",
"operationId": "GetInvoiceDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/{documentNo}/file": {
"get": {
"tags": [
"InvoiceDocuments"
],
"summary": "",
"operationId": "GetInvoiceDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"InvoiceDocuments"
],
"operationId": "AddInvoiceDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"InvoiceDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetInvoiceDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"InvoiceDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetInvoiceDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/{documentNo}/copy": {
"get": {
"tags": [
"InvoiceDocuments"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyInvoiceDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/{documentNo}/usage": {
"get": {
"tags": [
"InvoiceDocuments"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetInvoiceDocumentsUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/{documentNo}/checkout": {
"put": {
"tags": [
"InvoiceDocuments"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutInvoiceDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/InvoiceDocuments/{documentNo}/checkin": {
"post": {
"tags": [
"InvoiceDocuments"
],
"summary": "",
"operationId": "CheckinInvoiceDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ImInvoice_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/IosDataSync/ResetObjectIosDataSync": {
"post": {
"tags": [
"IosDataSync"
],
"operationId": "ResetObjectIosDataSync",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.IosDataSyncResetObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.IosDataSyncResetObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.IosDataSyncResetObject"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.IosDataSyncResetObject"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.IosDataSyncResetObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.IosDataSyncResetObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.IosDataSyncResetObject"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroups": {
"get": {
"tags": [
"ItemGroups"
],
"summary": "Gets a list of ItemGroups",
"operationId": "GetItemGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ItemGroups"
],
"summary": "Creates a new itemGroup record",
"operationId": "CreateItemGroup",
"requestBody": {
"description": "The ItemGroup Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroups/{itemGroupNo}": {
"get": {
"tags": [
"ItemGroups"
],
"summary": "Gets a specific ItemGroup",
"operationId": "GetItemGroup",
"parameters": [
{
"name": "itemGroupNo",
"in": "path",
"description": "the itemGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested itemGroup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an itemGroup with the supplied ItemGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ItemGroups"
],
"summary": "Updates an existing ItemGroup",
"operationId": "UpdateItemGroup",
"parameters": [
{
"name": "itemGroupNo",
"in": "path",
"description": "The itemGroupNo of the itemGroup to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ItemGroup DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ItemGroup object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ItemGroups"
],
"summary": "Deletes an itemGroup record",
"parameters": [
{
"name": "itemGroupNo",
"in": "path",
"description": "The itemGroupNo of the ItemGroup to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartGroup_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroups/{itemGroupNo}/history": {
"get": {
"tags": [
"ItemGroups"
],
"summary": "Gets history for a specific ItemGroup",
"operationId": "GetItemGroupHistory",
"parameters": [
{
"name": "itemGroupNo",
"in": "path",
"description": "The itemGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested itemGroup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an itemGroup with the supplied ItemGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartGroup_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroups/search": {
"post": {
"tags": [
"ItemGroups"
],
"summary": "Search for itemGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchItemGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroups/searchCount": {
"post": {
"tags": [
"ItemGroups"
],
"summary": "Returns number of hits in a search for ItemGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountItemGroups",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroups/searchIndex/{itemGroupGuid}": {
"post": {
"tags": [
"ItemGroups"
],
"summary": "Get index of a record in a search for ItemGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexItemGroups",
"parameters": [
{
"name": "itemGroupGuid",
"in": "path",
"description": "The itemGroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroups/searchInfo": {
"get": {
"tags": [
"ItemGroups"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoItemGroups",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ItemGroups/{itemGroupNo}/copy": {
"get": {
"tags": [
"ItemGroups"
],
"summary": "Copies an existing itemGroup to a new object",
"operationId": "CopyItemGroup",
"parameters": [
{
"name": "itemGroupNo",
"in": "path",
"description": "The ItemGroupNo of the itemGroup to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ItemGroup object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroupSelection/{itemGroupNo}": {
"get": {
"tags": [
"ItemGroupSelection"
],
"operationId": "GetItemGroupSelection",
"parameters": [
{
"name": "itemGroupNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitSparePartGroups | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroupSelection/{itemGroupNo}/history": {
"get": {
"tags": [
"ItemGroupSelection"
],
"operationId": "GetItemGroupSelectionHistory",
"parameters": [
{
"name": "itemGroupNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitSparePartGroups | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroupSelectionTree": {
"get": {
"tags": [
"ItemGroupSelectionTree"
],
"operationId": "ItemGroupSelectionTree",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitSparePartGroups | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ItemGroupSelectionTree"
],
"operationId": "UpdateItemGroupSelections",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitSparePartGroups | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroupSelectionTree/{itemGroupNo}/children": {
"get": {
"tags": [
"ItemGroupSelectionTree"
],
"operationId": "GetItemGroupSelectionChildren",
"parameters": [
{
"name": "itemGroupNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitSparePartGroups | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemGroupSelectionTree/{itemGroupNo}": {
"get": {
"tags": [
"ItemGroupSelectionTree"
],
"operationId": "GetItemGroupSelectionTreeFromNode",
"parameters": [
{
"name": "itemGroupNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitSparePartGroups | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocations": {
"get": {
"tags": [
"ItemLocations"
],
"summary": "Gets a list of ItemLocations",
"operationId": "GetItemLocations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ItemLocations"
],
"summary": "Creates a new itemLocation record",
"operationId": "CreateItemLocation",
"requestBody": {
"description": "The ItemLocation Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocations/{itemLocationNo}": {
"get": {
"tags": [
"ItemLocations"
],
"summary": "Gets a specific ItemLocation",
"operationId": "GetItemLocation",
"parameters": [
{
"name": "itemLocationNo",
"in": "path",
"description": "The ItemLocationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested itemLocation",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an itemLocation with the supplied ItemLocation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ItemLocations"
],
"summary": "Updates an existing ItemLocation",
"operationId": "UpdateItemLocation",
"parameters": [
{
"name": "itemLocationNo",
"in": "path",
"description": "The ItemLocationNo of the itemLocation to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ItemLocation DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ItemLocation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ItemLocations"
],
"summary": "Deletes a itemLocation record",
"parameters": [
{
"name": "itemLocationNo",
"in": "path",
"description": "The ItemLocationNo of the ItemLocation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocations/{itemLocationNo}/history": {
"get": {
"tags": [
"ItemLocations"
],
"summary": "Gets history for a specific ItemLocation",
"operationId": "GetItemLocationHistory",
"parameters": [
{
"name": "itemLocationNo",
"in": "path",
"description": "The ItemLocationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested itemLocation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an itemLocation with the supplied ItemLocation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocations/search": {
"post": {
"tags": [
"ItemLocations"
],
"summary": "Search for ItemLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchItemLocations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested itemLocation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocations/searchCount": {
"post": {
"tags": [
"ItemLocations"
],
"summary": "Returns number of hits in a search for ItemLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountItemLocations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocations/searchIndex/{ItemLocationGuid}": {
"post": {
"tags": [
"ItemLocations"
],
"summary": "Get index of a record in a search for ItemLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexItemLocations",
"parameters": [
{
"name": "itemLocationGuid",
"in": "path",
"description": "The itemLocation to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocations/searchInfo": {
"get": {
"tags": [
"ItemLocations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoItemLocations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ItemLocations/{itemLocationNo}/copy": {
"get": {
"tags": [
"ItemLocations"
],
"summary": "Copies an existing itemLocation to a new object",
"operationId": "CopyItemLocation",
"parameters": [
{
"name": "itemLocationNo",
"in": "path",
"description": "The itemLocationNo of the itemLocation to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new itemLocation object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocations/labels/{documentNo}": {
"post": {
"tags": [
"ItemLocations"
],
"summary": "Gets the labels to print",
"operationId": "PrintItemLocationLabels",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "the template No to print",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A Search Definition containing the item numbers to print",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested item report as pdf"
},
"404": {
"description": "If a item with the supplied Item No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocations/labels/{labelTemplateDocumentNo}/{settingsKey}": {
"get": {
"tags": [
"ItemLocations"
],
"summary": "Get the labels to print using ´settings key",
"operationId": "GetItemLocationLabelPdf",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "The template No to print",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "settingsKey",
"in": "path",
"description": "The UUID for the stored search definition",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocations/{itemLocationNo}/itemCount": {
"post": {
"tags": [
"ItemLocations"
],
"summary": "Returns the number of items that uses the specified item location or any of it's sub locations",
"operationId": "GetItemLocationItemCount",
"parameters": [
{
"name": "itemLocationNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.ItemLocation"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocationTree": {
"get": {
"tags": [
"ItemLocationTree"
],
"operationId": "ItemLocationTree",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocationTree/{nodeType}/{visibleKey}/children": {
"get": {
"tags": [
"ItemLocationTree"
],
"operationId": "GetItemLocationTreeChildren",
"parameters": [
{
"name": "nodeType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNodeType"
}
},
{
"name": "visibleKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemLocationTree/{nodeType}/{visibleKey}": {
"get": {
"tags": [
"ItemLocationTree"
],
"operationId": "GetItemLocationTreeFromNode",
"parameters": [
{
"name": "nodeType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNodeType"
}
},
{
"name": "visibleKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "parentWarehouseKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "parentItemLocationKey",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos": {
"get": {
"tags": [
"ItemPhotos"
],
"summary": "Gets a list of ItemPhotos",
"operationId": "GetItemPhotos",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ItemPhotos"
],
"summary": "Creates a new document record",
"operationId": "CreateItemPhoto",
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/{documentNo}": {
"get": {
"tags": [
"ItemPhotos"
],
"summary": "Gets a specific ItemPhoto",
"operationId": "GetItemPhoto",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ItemPhotos"
],
"summary": "Updates an existing Document",
"operationId": "UpdateItemPhoto",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ItemPhotos"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/searchIndex/{documentGuid}": {
"post": {
"tags": [
"ItemPhotos"
],
"summary": "Get index of a record in a search for ItemPhoto\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexItemPhotos",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/{documentNo}/history": {
"get": {
"tags": [
"ItemPhotos"
],
"summary": "Gets history for a specific ItemPhoto",
"operationId": "GetItemPhotoHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/search": {
"post": {
"tags": [
"ItemPhotos"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchItemPhotos",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/searchCount": {
"post": {
"tags": [
"ItemPhotos"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountItemPhotos",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/searchInfo": {
"get": {
"tags": [
"ItemPhotos"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoItemPhotos",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ItemPhotos/{documentNo}/pdf": {
"get": {
"tags": [
"ItemPhotos"
],
"summary": "",
"operationId": "GetItemPhotoPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/{documentNo}/file": {
"get": {
"tags": [
"ItemPhotos"
],
"summary": "",
"operationId": "GetItemPhotoFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ItemPhotos"
],
"operationId": "AddItemPhotoFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "imageDimension",
"in": "query",
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
}
},
{
"name": "imageQuality",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 80
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"ItemPhotos"
],
"summary": "Get document pdf from guid",
"operationId": "GetItemPhotoPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"ItemPhotos"
],
"summary": "Get document file from guid",
"operationId": "GetItemPhotoFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/{documentNo}/checkout": {
"put": {
"tags": [
"ItemPhotos"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutItemPhotoFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/{documentNo}/checkin": {
"post": {
"tags": [
"ItemPhotos"
],
"summary": "",
"operationId": "CheckinItemPhotoFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/{documentNo}/copy": {
"get": {
"tags": [
"ItemPhotos"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyItemPhoto",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemPhotos/{documentNo}/usage": {
"get": {
"tags": [
"ItemPhotos"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetItemPhotosUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items": {
"get": {
"tags": [
"Items"
],
"summary": "Gets a list of Items",
"operationId": "GetItems",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Items"
],
"summary": "Creates a new item record",
"operationId": "CreateItem",
"requestBody": {
"description": "The Item Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}": {
"get": {
"tags": [
"Items"
],
"summary": "Gets a specific Item",
"operationId": "GetItem",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "the ItemNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested item",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an item with the supplied Item No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Items"
],
"summary": "Updates an existing Item",
"operationId": "UpdateItem",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The ItemNo of the item to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Item DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Item object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Update | Update |
| SparePart_Update | Update |
| SparePart_AllowWarehouse | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Items"
],
"summary": "Deletes an item record",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The ItemNo of the Item to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/history": {
"get": {
"tags": [
"Items"
],
"summary": "Gets history for a specific Item",
"operationId": "GetItemHistory",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The ItemNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested item",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an item with the supplied Item No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/search": {
"post": {
"tags": [
"Items"
],
"summary": "Search for items\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchItems",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/searchCount": {
"post": {
"tags": [
"Items"
],
"summary": "Returns number of hits in a search for Items\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountItems",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/searchIndex/{sparePartGuid}": {
"post": {
"tags": [
"Items"
],
"summary": "Get index of a record in a search for Items\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexItems",
"parameters": [
{
"name": "sparePartGuid",
"in": "path",
"description": "The item to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/searchInfo": {
"get": {
"tags": [
"Items"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoItems",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Items/{itemNo}/force": {
"delete": {
"tags": [
"Items"
],
"summary": "Force deletes a item record\r\nForce deleting records may cause existing records to contain invalid data, that needs adjustment before they can be saved",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The ItemNo of the Item to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/warehouses": {
"get": {
"tags": [
"Items"
],
"summary": "Returns a list of warehouses on the Item",
"operationId": "GetItemWarehouses",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The Itemno to fetch warehouses for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the warehouses for the item",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemWarehouse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemWarehouse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemWarehouse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/adjuststock": {
"post": {
"tags": [
"Items"
],
"summary": "Performs a stock adjustment on the given item",
"operationId": "AdjustStock",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "Item no of the item to undergo a stock adjustment",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The adjustment to make",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.StockAdjustment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.StockAdjustment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.StockAdjustment"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.StockAdjustment"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartWarehouseTransaction | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/movestock": {
"post": {
"tags": [
"Items"
],
"summary": "Moves stock from one location to another",
"operationId": "MoveStock",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "Item no of the item to undergo a stock adjustment",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The adjustment to make",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.StockMovement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.StockMovement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.StockMovement"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.StockMovement"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartWarehouseTransaction | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/Suppliers": {
"get": {
"tags": [
"Items"
],
"summary": "Returns a list of Suppliers used for the Item",
"operationId": "GetItemSuppliers",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The ItemNo to fetch suppliers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the suppliers for the Item",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/searchitemsuppliers": {
"post": {
"tags": [
"Items"
],
"summary": "Returns a list of Suppliers used for the items sent with the body.",
"operationId": "GetMultipleItemSuppliers",
"requestBody": {
"description": "The ItemNos to fetch suppliers for",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the suppliers for the Item",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/Suppliers/{supplierNo}": {
"get": {
"tags": [
"Items"
],
"summary": "Returns a specific Item Supplier",
"operationId": "GetItemSupplier",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The ItemNo",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "supplierNo",
"in": "path",
"description": "The supplierNo to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the component",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
}
}
}
},
"404": {
"description": "If a item supplier with the supplied ItemNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/copy": {
"get": {
"tags": [
"Items"
],
"summary": "Copies an existing Item to a new object",
"operationId": "CopyItem",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The ItemNo of the item to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Item object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePart_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/labels/{documentNo}": {
"post": {
"tags": [
"Items"
],
"summary": "Gets the labels to print",
"operationId": "PrintItemLabels",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "the template No to print",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A Search Definition containing the item numbers to print",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested item report as pdf"
},
"404": {
"description": "If a item with the supplied Item No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/labels/{labelTemplateDocumentNo}/{settingsKey}": {
"get": {
"tags": [
"Items"
],
"summary": "Get the labels to print using ´settings key",
"operationId": "GetItemLabelPdf",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "The template No to print",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "settingsKey",
"in": "path",
"description": "The UUID for the stored search definition",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/Components": {
"get": {
"tags": [
"Items"
],
"summary": "Returns a list of ComponentItems (M2M relation object)",
"operationId": "GetItemComponents",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The ItemNo to fetch Components for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the component",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/Suppliers/{supplierNo}/Prices": {
"get": {
"tags": [
"Items"
],
"summary": "Returns a list of ItemSupplierPrice objects.",
"operationId": "GetItemSupplierPrices",
"parameters": [
{
"name": "itemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "supplierNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Prices of an Item Supplier",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPrice"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPrice"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPrice"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/ItemGroups": {
"get": {
"tags": [
"Items"
],
"summary": "Returns a list of ItemGroups used for the Item",
"operationId": "GetItemItemGroups",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The ItemNo to fetch suppliers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Item Groups for the Item",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemItemGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemItemGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemItemGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/documents": {
"get": {
"tags": [
"Items"
],
"summary": "Returns a list of Documents used on the Item",
"operationId": "GetItemDocuments",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The item no. to fetch documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the documents for the item",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/appSubmitStockMovement": {
"post": {
"tags": [
"Items"
],
"summary": "Makes a stock movement using the applied AppStockMovement data",
"operationId": "ReceiveStockMovement",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.AppStockMovement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.AppStockMovement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.AppStockMovement"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.AppStockMovement"
}
}
}
},
"responses": {
"200": {
"description": ""
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartWarehouseTransaction | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/units": {
"get": {
"tags": [
"Items"
],
"summary": "Returns a list of ItemUnits",
"operationId": "GetItemUnits",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "The ItemNo to fetch Units for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "historyMode",
"in": "query",
"description": "",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the component",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/appGetUnavailableItems": {
"post": {
"tags": [
"Items"
],
"summary": "Returns a list of ItemGroups used for the Item",
"operationId": "GetUnavailableItems",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns a list of ItemGuid that are no longer available",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemItemGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemItemGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemItemGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/purchaseOrders/count": {
"get": {
"tags": [
"Items"
],
"summary": "Returns the number of purchase orders where the item is linked",
"operationId": "GetItemPurchaseOrdersCount",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/purchaseOrders": {
"get": {
"tags": [
"Items"
],
"summary": "Returns the purchase orders where the item is linked",
"operationId": "GetItemPurchaseOrders",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.ItemPurchaseOrderView"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.ItemPurchaseOrderView"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.ItemPurchaseOrderView"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/priceHistory": {
"get": {
"tags": [
"Items"
],
"summary": "Get the price history for the item",
"operationId": "GetItemPriceHistory",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.ItemPriceHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.ItemPriceHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.ItemPriceHistory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/suppliers/{supplierNo}/ports": {
"get": {
"tags": [
"Items"
],
"summary": "Returns a list of Item Supplier Ports.",
"operationId": "GetItemSupplierPorts",
"parameters": [
{
"name": "itemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "supplierNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPort"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPort"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPort"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/suppliers/{supplierNo}/ports/{portCodeNo}/prices": {
"get": {
"tags": [
"Items"
],
"operationId": "GetItemSupplierPortPrices",
"parameters": [
{
"name": "itemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "supplierNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "portCodeNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPortPrice"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPortPrice"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPortPrice"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.NotFoundResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/propertyDefinitions": {
"get": {
"tags": [
"Items"
],
"summary": "Get a list of PropertyDefinitions",
"operationId": "GetItemPropertyDefinitions",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Items"
],
"summary": "Creates a new PropertyDefinition record",
"operationId": "CreateItemPropertyDefinition",
"requestBody": {
"description": "The PropertyDefinition DTO object to create",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/propertyDefinitions/{propertyDefinitionGuid}": {
"get": {
"tags": [
"Items"
],
"summary": "Gets a specific PropertyDefinition",
"operationId": "GetItemPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested PropertyDefinition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an GetPropertyDefinition with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Items"
],
"summary": "Updates an existing PropertyDefinition",
"operationId": "UpdateItemPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The PropertyDefinition DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PropertyDefinition object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Items"
],
"summary": "Deletes a PropertyDefinition record",
"operationId": "DeleteItemPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/propertyDefinitions/{propertyDefinitionGuid}/listValues": {
"get": {
"tags": [
"Items"
],
"summary": "Returns a list of values for a PropertyDefinition",
"operationId": "GetItemPropertyDefinitionListValues",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The PropertyDefinition Guid to fetch values for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "textFilter",
"in": "query",
"description": "(optional) text filter",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the values for the ListOfValuesTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/propertyDefinitions/{propertyDefinitionGuid}/force": {
"delete": {
"tags": [
"Items"
],
"summary": "Force Deletes a PropertyDefinition record",
"operationId": "ForceDeleteItemPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/propertyDefinitions/{propertyName}/available": {
"get": {
"tags": [
"Items"
],
"summary": "Lookup if PropertyName of a PropertyDefinition is not already in use and therefore available to be used",
"operationId": "ItemPropertyNameAvailable",
"parameters": [
{
"name": "propertyName",
"in": "path",
"description": "The propertyName to check",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns true is property name is available to be used",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/screenLayout": {
"post": {
"tags": [
"Items"
],
"summary": "Bulk updates screenlayout and a list of Property Definitions. The endpoint handles whether or not to create or update each record in the requst.",
"operationId": "BulkUpdateItemScreenLayout",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/webhooklogs/search": {
"post": {
"tags": [
"Items"
],
"summary": "Searches the Webhooks associated with the Item.",
"operationId": "SearchItemWebhookLogs",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| WebhooksIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/webhooklogs/searchCount": {
"post": {
"tags": [
"Items"
],
"summary": "Returns number of hits in a search for the Item's Webhook Logs.\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchItemWebhookLogsCount",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/webhooklogs/{webhookLogGuid}/retransmit": {
"post": {
"tags": [
"Items"
],
"summary": "Retransmits a specific Webhook based on the selected Webhook Log.",
"operationId": "RetransmitItemWebhookLog",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookLogGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Items/{itemNo}/webhooklogs/{webhookLogGuid}/resolve": {
"post": {
"tags": [
"Items"
],
"summary": "Resolves a specific Webhook Log with a Response Log entry.",
"operationId": "ResolveItemWebhookLog",
"parameters": [
{
"name": "itemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookLogGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemTree": {
"get": {
"tags": [
"ItemTree"
],
"operationId": "ItemTree",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartTree | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemTree/{nodeType}/{visibleKey}/children": {
"get": {
"tags": [
"ItemTree"
],
"operationId": "GetItemTreeChildren",
"parameters": [
{
"name": "nodeType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNodeType"
}
},
{
"name": "visibleKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartTree | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemTree/{nodeType}/{visibleKey}": {
"get": {
"tags": [
"ItemTree"
],
"operationId": "GetItemTreeFromNode",
"parameters": [
{
"name": "nodeType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNodeType"
}
},
{
"name": "visibleKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "parentGroupKey",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "parentItemKey",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SparePartTree | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemTypes": {
"get": {
"tags": [
"ItemTypes"
],
"summary": "Gets a list of ItemTypes",
"operationId": "GetItemTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ItemTypes"
],
"summary": "Creates a new itemType record",
"operationId": "CreateItemType",
"requestBody": {
"description": "The ItemType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ItemType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemTypes/{itemTypeNo}": {
"get": {
"tags": [
"ItemTypes"
],
"summary": "Gets a specific ItemType",
"operationId": "GetItemType",
"parameters": [
{
"name": "itemTypeNo",
"in": "path",
"description": "The ItemTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested itemType",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an itemType with the supplied ItemType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ItemTypes"
],
"summary": "Updates an existing ItemType",
"operationId": "UpdateItemType",
"parameters": [
{
"name": "itemTypeNo",
"in": "path",
"description": "The ItemTypeNo of the itemType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ItemType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ItemType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ItemType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ItemTypes"
],
"summary": "Deletes a itemType record",
"parameters": [
{
"name": "itemTypeNo",
"in": "path",
"description": "The ItemTypeNo of the ItemType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ItemType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemTypes/{itemTypeNo}/history": {
"get": {
"tags": [
"ItemTypes"
],
"summary": "Gets history for a specific ItemType",
"operationId": "GetItemTypeHistory",
"parameters": [
{
"name": "itemTypeNo",
"in": "path",
"description": "The ItemTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested itemType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an itemType with the supplied ItemType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ItemType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemTypes/search": {
"post": {
"tags": [
"ItemTypes"
],
"summary": "Search for ItemTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchItemTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemTypes/searchCount": {
"post": {
"tags": [
"ItemTypes"
],
"summary": "Returns number of hits in a search for ItemTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountItemTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemTypes/searchIndex/{itemTypeGuid}": {
"post": {
"tags": [
"ItemTypes"
],
"summary": "Get index of a record in a search for ItemTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexItemTypes",
"parameters": [
{
"name": "itemTypeGuid",
"in": "path",
"description": "The item to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemTypes/searchInfo": {
"get": {
"tags": [
"ItemTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoItemTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ItemTypes/{itemTypeNo}/copy": {
"get": {
"tags": [
"ItemTypes"
],
"summary": "Copies an existing itemType to a new object",
"operationId": "CopyItemType",
"parameters": [
{
"name": "itemTypeNo",
"in": "path",
"description": "The itemTypeNo of the itemType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new itemType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ItemType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemWarehouseHistories/search": {
"post": {
"tags": [
"ItemWarehouseHistories"
],
"summary": "Search for itemWarehouseHistories\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchItemWarehouseHistories",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemWarehouseHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemWarehouseHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemWarehouseHistory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemWarehouseHistories/searchInfo": {
"get": {
"tags": [
"ItemWarehouseHistories"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoItemWarehouseHistories",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ItemWarehouseHistories/searchCount": {
"post": {
"tags": [
"ItemWarehouseHistories"
],
"summary": "Returns number of hits in a search for Items\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountItemWarehouseHistories",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemWarehouses/search": {
"post": {
"tags": [
"ItemWarehouses"
],
"summary": "Search for itemWarehouses\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchItemWarehouses",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemWarehouse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemWarehouse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemWarehouse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ItemWarehouses/searchInfo": {
"get": {
"tags": [
"ItemWarehouses"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoItemWarehouses",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ItemWarehouses/searchCount": {
"post": {
"tags": [
"ItemWarehouses"
],
"summary": "Returns number of hits in a search for Items\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountItemWarehouses",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobGroups": {
"get": {
"tags": [
"JobGroups"
],
"summary": "Gets a list of JobGroups",
"operationId": "GetJobGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"JobGroups"
],
"summary": "Creates a new jobGroup record",
"operationId": "CreateJobGroup",
"requestBody": {
"description": "The JobGroup Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobGroups/{jobGroupNo}": {
"get": {
"tags": [
"JobGroups"
],
"summary": "Gets a specific JobGroup",
"operationId": "GetJobGroup",
"parameters": [
{
"name": "jobGroupNo",
"in": "path",
"description": "The JobGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobGroup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobGroup with the supplied JobGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"JobGroups"
],
"summary": "Updates an existing JobGroup",
"operationId": "UpdateJobGroup",
"parameters": [
{
"name": "jobGroupNo",
"in": "path",
"description": "The JobGroupNo of the jobGroup to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobGroup DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobGroup object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"JobGroups"
],
"summary": "Deletes a jobGroup record",
"parameters": [
{
"name": "jobGroupNo",
"in": "path",
"description": "The JobGroupNo of the JobGroup to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobGroup_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobGroups/{jobGroupNo}/history": {
"get": {
"tags": [
"JobGroups"
],
"summary": "Gets history for a specific JobGroup",
"operationId": "GetJobGroupHistory",
"parameters": [
{
"name": "jobGroupNo",
"in": "path",
"description": "The JobGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobGroup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobGroup with the supplied JobGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobGroup_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobGroups/search": {
"post": {
"tags": [
"JobGroups"
],
"summary": "Search for JobGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobGroups/searchIndex/{jobGroupGuid}": {
"post": {
"tags": [
"JobGroups"
],
"summary": "Get index of a record in a search for jobgroup\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobGroups",
"parameters": [
{
"name": "jobGroupGuid",
"in": "path",
"description": "The jobgroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobGroups/searchCount": {
"post": {
"tags": [
"JobGroups"
],
"summary": "Returns number of hits in a search for JobGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobGroups",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobGroups/searchInfo": {
"get": {
"tags": [
"JobGroups"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobGroups",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobGroups/{jobGroupNo}/copy": {
"get": {
"tags": [
"JobGroups"
],
"summary": "Copies an existing JobGroup to a new object",
"operationId": "CopyJobGroup",
"parameters": [
{
"name": "jobGroupNo",
"in": "path",
"description": "The JobGroupNo of the jobGroup to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new JobGroup object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobGroups/{jobGroupNo}/formTemplates": {
"get": {
"tags": [
"JobGroups"
],
"summary": "Fetches all FormTemplates attached to the JobGroup",
"operationId": "GetJobGroupFormTemplates",
"parameters": [
{
"name": "jobGroupNo",
"in": "path",
"description": "The Job Group No to fetch Form Templates for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Form Templates for the Job Group",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroupFormTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroupFormTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroupFormTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobGroup | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Gets a list of JobHistories",
"operationId": "GetJobHistories",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Gets a specific JobHistory",
"operationId": "GetJobHistory",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The guid of the JobHistory to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobHistory",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobHistory with the supplied JobHistory No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"JobHistories"
],
"summary": "Updates an existing JobHistory",
"operationId": "UpdateJobHistory",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The JobHistory guid of the jobHistory to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The JobHistory DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobHistory object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobHistory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"JobHistories"
],
"summary": "Deletes a jobHistory record",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The JobHistoryNo of the JobHistory to delete",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobHistory_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/history": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Gets history for a specific JobHistory",
"operationId": "GetJobHistoryHistory",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The JobHistoryNo to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobHistory",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobHistory with the supplied JobHistory No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobHistory_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/search": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Search for JobHistories\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobHistories",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested jobHistory",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/searchCount": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Returns number of hits in a search for JobHistories\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobHistories",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/searchInfo": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobHistories",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobHistories/searchIndex/{jobHistoryGuid}": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Get index of a record in a search for job histories\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobHistories",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"description": "The job history to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/Finalize": {
"put": {
"tags": [
"JobHistories"
],
"summary": "Finalizes a jobhistory",
"operationId": "FinalizeJobHistory",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The jobhistory to finalizy",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The jobhistory to finalize",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
},
"responses": {
"200": {
"description": "Returns a Job Deactivation Result with information about the deactivated jobs",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
}
}
},
"400": {
"description": "Returns a Job Deactivation Result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
}
}
},
"404": {
"description": "Returns not found if no JobHistory exists with the supplied jobhistoryGuid"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobHistory_Finalize | Finalize |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/resources": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Fetches all Resources attached to the jobhistory",
"operationId": "GetJobHistoryResources",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The guid to fetch resources for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the resources for the jobhistory",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/resources/{resourceNo}": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Fetches a specific Resource attached to the jobhistory",
"operationId": "GetJobHistoryResource",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The guid to fetch resources for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "resourceNo",
"in": "path",
"description": "The resource no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the resources for the jobhistory",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResource"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/items": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Returns a list of Items used to perform the JobHistory",
"operationId": "GetJobHistoryItems",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The JobHistoryno to fetch items for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the jobHistory",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/items/{itemNo}": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Returns a specific jobHistory Item",
"operationId": "GetJobHistoryItem",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The JobHistoryno",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "itemNo",
"in": "path",
"description": "The itemNo to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the jobHistory",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryItem"
}
}
}
},
"404": {
"description": "If a jobHistory item with the supplied ItemNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/jobgroups": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Fetches all JobGroups attached to the jobHistory",
"operationId": "GetJobHistoryJobGroups",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The JobHistory guid to fetch jobgroups for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the jobHistorygroups for the jobHistory",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryJobGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryJobGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryJobGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/jobgroups/{jobgroupNo}": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Fetches a specific JobHistoryGroup attached to the jobHistory",
"operationId": "GetJobHistoryJobGroup",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The JobHistory guid to fetch jobgroups for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "jobgroupNo",
"in": "path",
"description": "The jobgroup no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the jobHistorygroups for the jobHistory",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryJobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryJobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryJobGroup"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/documents": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Returns a list of Documents used on the JobHistory",
"operationId": "GetJobHistoryDocuments",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The guid to fetch documents for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the triggers for the jobhistory",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobHistoryGuid}/documents/{documentNo}": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Returns a specific jobHistory document",
"operationId": "GetJobHistoryDocument",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The Jobno",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "documentNo",
"in": "path",
"description": "The no of the document to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the document for the jobHistory",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
}
},
"404": {
"description": "If a jobHistory document with the supplied no cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/Reopen": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Reopens a finalized job history",
"operationId": "ReopenJobHistory",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AllowReopenJobHistory | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/formTemplates": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Fetches all FormTemplates attached to the jobhistory",
"operationId": "GetJobHistoryFormTemplates",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The guid to fetch formTemplates for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the formTemplates for the jobhistory",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/formTemplate/{jobHistoryFormTemplateGuid}": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Fetches a specific FormTemplate attached to the jobhistory",
"operationId": "GetJobHistoryFormTemplate",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The Guid to fetch formTemplates for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "jobHistoryFormTemplateGuid",
"in": "path",
"description": "The guid of the reference object to fetch",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the formTemplates for the jobhistory",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/formTemplates/createForm": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Creates a Form based on the supplied JobHistoryFormTemplate object",
"operationId": "CreateJobHistoryFormTemplateForm",
"parameters": [
{
"name": "jobhistoryGuid",
"in": "path",
"description": "The guid of the jobhistory which FormTemplate belongs to",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The JobHistoryformTemplate reference to create form for",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the JobFormTemplate after form is created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobHistory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/appSubmit": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Receive Job History from Forms on job app",
"operationId": "ReceiveJobHistory",
"requestBody": {
"description": "The Job History to Receive",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobHistoryAppObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobHistoryAppObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobHistoryAppObject"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobHistoryAppObject"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/AddDocuments": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Updates an existing finalized JobHistory with documents",
"operationId": "AddDocuments",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"description": "The JobHistory guid of the jobHistory to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The documents to add",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobHistory object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobHistory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobHistoryGuid}/responses": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Gets a list of Job History Responses",
"operationId": "GetJobHistoryResponses",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"description": "The Job History Guid. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobHistoryGuid}/responses/count": {
"get": {
"tags": [
"JobHistories"
],
"summary": "Returns number of JobHistoryResponses for jobHistoryGuid",
"operationId": "CountJobhistoryResponses",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"description": "The JobHistoryGuid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobHistoryGuid}/addResponse": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Add response",
"operationId": "AddResponse",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"description": "The jobHistoryGuid to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobHistoryResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobHistory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobHistoryGuid}/dataEntryLink": {
"get": {
"tags": [
"JobHistories"
],
"operationId": "GetJobHistoryDataEntryLink",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobHistoryGuid}/webhooklogs/search": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Searches the Webhooks associated with the Job History.",
"operationId": "SearchJobHistoryWebhookLogs",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| WebhooksIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobHistoryGuid}/webhooklogs/searchCount": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Returns number of hits in a search for the Job History's Webhook Logs.\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobHistoryWebhookLogsCount",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobHistoryGuid}/webhooklogs/{webhookLogGuid}/retransmit": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Retransmits a specific Webhook based on the selected Webhook Log.",
"operationId": "RetransmitJobHistoryWebhookLog",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "webhookLogGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobHistoryGuid}/webhooklogs/{webhookLogGuid}/resolve": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Resolves a specific Webhook Log with a Response Log entry.",
"operationId": "ResolveJobHistoryWebhookLog",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "webhookLogGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistories/{jobhistoryGuid}/Acknowledge": {
"post": {
"tags": [
"JobHistories"
],
"summary": "Acknowledges a job history",
"operationId": "AcknowledgeJobHistory",
"parameters": [
{
"name": "jobHistoryGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistory"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Allow_Update_Acknowledge_JobHistory | Update |
Customer must have one of these License values set| Key | Right |
|---|
| AcknowledgeJobHistories |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobHistoryDataEntries": {
"get": {
"tags": [
"JobHistoryDataEntries"
],
"summary": "Gets a specific JobHistoryDataEntry",
"operationId": "GetJobHistoryDataEntry",
"responses": {
"200": {
"description": "Returns the requested JobHistoryDataEntry data entry",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistoryDataEntryWeb.JobHistoryDataEntry"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistoryDataEntryWeb.JobHistoryDataEntry"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistoryDataEntryWeb.JobHistoryDataEntry"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request"
},
"404": {
"description": "If an JobHistoryDataEntry data entry with the supplied JobHistoryDataEntry No cannot be found"
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| JobHistoryDataEntryWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobHistoryDataEntries/documents": {
"get": {
"tags": [
"JobHistoryDataEntries"
],
"summary": "Returns a list of Documents used on the JobHistoryDataEntry data entry",
"operationId": "GetJobHistoryDataEntryDocuments",
"responses": {
"200": {
"description": "Returns the documents for the JobHistoryDataEntry data entry",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| JobHistoryDataEntryWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobHistoryDataEntries/documents/{documentNo}": {
"get": {
"tags": [
"JobHistoryDataEntries"
],
"summary": "Returns a specific Job History data entry document",
"operationId": "GetJobHistoryDataEntryDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The no of the document to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the document for the jobHistory",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
}
}
}
},
"404": {
"description": "If a jobHistory document with the supplied no cannot be found"
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| JobHistoryDataEntryWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobHistoryDataEntries/finalize": {
"put": {
"tags": [
"JobHistoryDataEntries"
],
"summary": "Updates an existing JobHistoryDataEntry and Finalizes the Job History",
"operationId": "FinalizeJobHistoryDataEntry",
"requestBody": {
"description": "The JobHistoryDataEntry DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistoryDataEntryWeb.JobHistoryDataEntry"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistoryDataEntryWeb.JobHistoryDataEntry"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistoryDataEntryWeb.JobHistoryDataEntry"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistoryDataEntryWeb.JobHistoryDataEntry"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobHistoryDataEntry object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| JobHistoryDataEntryWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobHistoryDataEntryDocuments/{documentNo}": {
"get": {
"tags": [
"JobHistoryDataEntryDocuments"
],
"summary": "Gets a specific Document",
"operationId": "JobHistoryDataEntryGetDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| JobHistoryDataEntryWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobHistoryDataEntryDocuments": {
"post": {
"tags": [
"JobHistoryDataEntryDocuments"
],
"summary": "Creates a new document record",
"operationId": "JobHistoryDataEntryCreateDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| JobHistoryDataEntryWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobHistoryDataEntryDocuments/search": {
"post": {
"tags": [
"JobHistoryDataEntryDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "JobHistoryDataEntrySearchDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| JobHistoryDataEntryWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobHistoryDataEntryDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"JobHistoryDataEntryDocuments"
],
"summary": "",
"operationId": "JobHistoryDataEntryGetDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| JobHistoryDataEntryWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobHistoryDataEntryDocuments/{documentNo}/file": {
"get": {
"tags": [
"JobHistoryDataEntryDocuments"
],
"summary": "",
"operationId": "JobHistoryDataEntryGetDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| JobHistoryDataEntryWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
},
"post": {
"tags": [
"JobHistoryDataEntryDocuments"
],
"operationId": "JobHistoryDataEntryAddDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| JobHistoryDataEntryWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobListWebSearch": {
"get": {
"tags": [
"JobListWebSearch"
],
"summary": "Gets a list of JobListWebSearchs",
"operationId": "GetJobListWebSearchs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"JobListWebSearch"
],
"summary": "Creates a new JobListWebSearch record",
"operationId": "CreateJobListWebSearch",
"requestBody": {
"description": "The JobListWebSearch Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch_Update | Update |
| LogbookEventSavedSearch_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobListWebSearch/{guid}": {
"get": {
"tags": [
"JobListWebSearch"
],
"summary": "Gets a specific JobListWebSearch",
"operationId": "GetJobListWebSearch",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The JobListWebSearchNo to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested JobListWebSearch",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an JobListWebSearch with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"JobListWebSearch"
],
"summary": "Updates an existing JobListWebSearch",
"operationId": "UpdateJobListWebSearch",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid of the JobListWebSearch to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The JobListWebSearch DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobListWebSearch object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch_Update | Update |
| LogbookEventSavedSearch_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"JobListWebSearch"
],
"summary": "Deletes a JobListWebSearch record",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The Guid of the JobListWebSearch to delete",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch_Delete | Delete |
| LogbookEventSavedSearch_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobListWebSearch/{guid}/history": {
"get": {
"tags": [
"JobListWebSearch"
],
"summary": "Gets history for a specific JobListWebSearch",
"operationId": "GetJobListWebSearchHistory",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The JobListWebSearchNo to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested JobListWebSearch",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a JobListWebSearch with the supplied guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch_HistoryMode | HistoryMode |
| LogbookEventSavedSearch_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobListWebSearch/searchIndex/{JobListWebSearchGuid}": {
"post": {
"tags": [
"JobListWebSearch"
],
"summary": "Get index of a record in a search for gridlayout\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobListWebSearchs",
"parameters": [
{
"name": "JobListWebSearchGuid",
"in": "path",
"description": "The JobListWebSearch to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobListWebSearch/search": {
"post": {
"tags": [
"JobListWebSearch"
],
"summary": "Search for JobListWebSearchs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobListWebSearchs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested JobListWebSearch",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearch"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobListWebSearch/searchCount": {
"post": {
"tags": [
"JobListWebSearch"
],
"summary": "Returns number of hits in a search for JobListWebSearchs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobListWebSearchs",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobListWebSearch/searchInfo": {
"get": {
"tags": [
"JobListWebSearch"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobListWebSearchs",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobListWebSearch/{guid}/users": {
"get": {
"tags": [
"JobListWebSearch"
],
"summary": "Fetches all users attached to the JobListWebSearch",
"operationId": "GetJobListWebSearchUsers",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid to fetch users for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the user for the JobListWebSearch",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobListWebSearch/{guid}/users/{userNo}": {
"get": {
"tags": [
"JobListWebSearch"
],
"summary": "Fetches a specific user attached to the JobListWebSearch",
"operationId": "GetJobListWebSearchUser",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The Guid to fetch users for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "userNo",
"in": "path",
"description": "The user no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the specific JobListWebSearchUser for the JobListWebSearch",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobListSavedSearch | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobMailTemplates": {
"get": {
"tags": [
"JobMailTemplates"
],
"summary": "Gets a list of JobMailTemplates",
"operationId": "GetJobMailTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobMailTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"JobMailTemplates"
],
"summary": "Creates a new jobMailTemplate record",
"operationId": "CreateJobMailTemplate",
"requestBody": {
"description": "The JobMailTemplate Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobMailTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobMailTemplates/{jobMailTemplateNo}": {
"get": {
"tags": [
"JobMailTemplates"
],
"summary": "Gets a specific JobMailTemplate",
"operationId": "GetJobMailTemplate",
"parameters": [
{
"name": "jobMailTemplateNo",
"in": "path",
"description": "The JobMailTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobMailTemplate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobMailTemplate with the supplied JobMailTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobMailTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"JobMailTemplates"
],
"summary": "Updates an existing JobMailTemplate",
"operationId": "UpdateJobMailTemplate",
"parameters": [
{
"name": "jobMailTemplateNo",
"in": "path",
"description": "The JobMailTemplateNo of the jobMailTemplate to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobMailTemplate DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobMailTemplate object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobMailTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"JobMailTemplates"
],
"summary": "Deletes a jobMailTemplate record",
"parameters": [
{
"name": "jobMailTemplateNo",
"in": "path",
"description": "The JobMailTemplateNo of the JobMailTemplate to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobMailTemplate_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobMailTemplates/{jobMailTemplateNo}/history": {
"get": {
"tags": [
"JobMailTemplates"
],
"summary": "Gets history for a specific JobMailTemplate",
"operationId": "GetJobMailTemplateHistory",
"parameters": [
{
"name": "jobMailTemplateNo",
"in": "path",
"description": "The JobMailTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobMailTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobMailTemplate with the supplied JobMailTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobMailTemplate_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobMailTemplates/search": {
"post": {
"tags": [
"JobMailTemplates"
],
"summary": "Search for JobMailTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobMailTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobMailTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobMailTemplates/searchIndex/{jobMailTemplateGuid}": {
"post": {
"tags": [
"JobMailTemplates"
],
"summary": "Get index of a record in a search for jobgroup\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobMailTemplates",
"parameters": [
{
"name": "jobMailTemplateGuid",
"in": "path",
"description": "The jobgroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobMailTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobMailTemplates/searchCount": {
"post": {
"tags": [
"JobMailTemplates"
],
"summary": "Returns number of hits in a search for JobMailTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobMailTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobMailTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobMailTemplates/searchInfo": {
"get": {
"tags": [
"JobMailTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobMailTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobMailTemplates/{jobMailTemplateNo}/copy": {
"get": {
"tags": [
"JobMailTemplates"
],
"summary": "Copies an existing JobMailTemplate to a new object",
"operationId": "CopyJobMailTemplate",
"parameters": [
{
"name": "jobMailTemplateNo",
"in": "path",
"description": "The JobMailTemplateNo of the jobMailTemplate to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new JobMailTemplate object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobMailTemplate.JobMailTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobMailTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRecommendations": {
"get": {
"tags": [
"JobRecommendations"
],
"summary": "Gets a list of JobRecommendations",
"operationId": "GetJobRecommendations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"JobRecommendations"
],
"summary": "Creates a new JobRecommendation record",
"operationId": "CreateJobRecommendation",
"requestBody": {
"description": "The JobRecommendation Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRecommendations/{jobRecommendationNo}": {
"get": {
"tags": [
"JobRecommendations"
],
"summary": "Gets a specific JobRecommendation",
"operationId": "GetJobRecommendation",
"parameters": [
{
"name": "jobRecommendationNo",
"in": "path",
"description": "The No of the JobRecommendation to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobRecommendation",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobRecommendation with the supplied JobRecommendation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"JobRecommendations"
],
"summary": "Updates an existing JobRecommendation",
"operationId": "UpdateJobRecommendation",
"parameters": [
{
"name": "jobRecommendationNo",
"in": "path",
"description": "The jobRecommendationNo of the jobRecommendation to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobRecommendation DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobRecommendation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRecommendations/{jobRecommendationNo}/history": {
"get": {
"tags": [
"JobRecommendations"
],
"summary": "Gets history for a specific JobRecommendation",
"operationId": "GetJobRecommendationHistory",
"parameters": [
{
"name": "jobRecommendationNo",
"in": "path",
"description": "The JobRecommendationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested JobRecommendation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an JobRecommendation with the supplied JobRecommendationNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRecommendations/search": {
"post": {
"tags": [
"JobRecommendations"
],
"summary": "Search for JobRecommendations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobRecommendations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRecommendations/searchCount": {
"post": {
"tags": [
"JobRecommendations"
],
"summary": "Returns number of hits in a search for JobRecommendations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobRecommendations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRecommendations/searchInfo": {
"get": {
"tags": [
"JobRecommendations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobRecommendations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRecommendations/searchIndex/{jobRecommendationNo}": {
"post": {
"tags": [
"JobRecommendations"
],
"summary": "Get index of a record in a search for JobRecommendations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobRecommendations",
"parameters": [
{
"name": "jobRecommendationGuid",
"in": "query",
"description": "The jobRecommendation to find index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "jobRecommendationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRecommendations/{jobRecommendationNo}/jobRecommendationResponses": {
"get": {
"tags": [
"JobRecommendations"
],
"summary": "Fetches all Responses attached to the JobRecommendation",
"operationId": "GetJobRecommendationResponses",
"parameters": [
{
"name": "jobRecommendationNo",
"in": "path",
"description": "The JobRecommendationNo to fetch jobRecommendationResponses for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "orderByAscCreateDate",
"in": "query",
"description": "Should result be order by create date",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Returns the jobRecommendationResponses for the form",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRecommendations/{jobRecommendationNo}/jobRecommendationDocuments": {
"get": {
"tags": [
"JobRecommendations"
],
"summary": "Fetches all Documents attached to the JobRecommendation",
"operationId": "GetJobRecommendationDocuments",
"parameters": [
{
"name": "jobRecommendationNo",
"in": "path",
"description": "The JobRecommendationNo to fetch jobRecommendationDocuments for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "orderByAscDocumentNo",
"in": "query",
"description": "Should result be order by DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Returns the jobRecommendationDocuments for the form",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRecommendations/{jobRecommendationNo}/jobRecommendationResponses/count": {
"get": {
"tags": [
"JobRecommendations"
],
"summary": "Returns number of JobRecommendationResponses for JobRecommendationNo",
"operationId": "CountJobRecommendationResponses",
"parameters": [
{
"name": "jobRecommendationNo",
"in": "path",
"description": "The JobRecommendationNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/jobRecommendations/{jobRecommendationNo}/addJobRecommendationResponse": {
"post": {
"tags": [
"JobRecommendations"
],
"summary": "Add response",
"operationId": "AddJobRecommendationResponse",
"parameters": [
{
"name": "jobRecommendationNo",
"in": "path",
"description": "The jobRecommendationNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobRecommendationResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRecommendation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestMailTemplates": {
"get": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Gets a list of JobRequestMailTemplates",
"operationId": "GetJobRequestMailTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestMailTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Creates a new jobMailTemplate record",
"operationId": "CreateJobRequestMailTemplate",
"requestBody": {
"description": "The JobRequestMailTemplate Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestMailTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestMailTemplates/{jobMailTemplateNo}": {
"get": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Gets a specific JobRequestMailTemplate",
"operationId": "GetJobRequestMailTemplate",
"parameters": [
{
"name": "jobMailTemplateNo",
"in": "path",
"description": "The JobRequestMailTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobMailTemplate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobMailTemplate with the supplied JobRequestMailTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestMailTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Updates an existing JobRequestMailTemplate",
"operationId": "UpdateJobRequestMailTemplate",
"parameters": [
{
"name": "jobMailTemplateNo",
"in": "path",
"description": "The JobRequestMailTemplateNo of the jobMailTemplate to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobRequestMailTemplate DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobRequestMailTemplate object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestMailTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Deletes a jobMailTemplate record",
"parameters": [
{
"name": "jobMailTemplateNo",
"in": "path",
"description": "The JobRequestMailTemplateNo of the JobRequestMailTemplate to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestMailTemplate_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestMailTemplates/{jobMailTemplateNo}/history": {
"get": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Gets history for a specific JobRequestMailTemplate",
"operationId": "GetJobRequestMailTemplateHistory",
"parameters": [
{
"name": "jobMailTemplateNo",
"in": "path",
"description": "The JobRequestMailTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobMailTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobMailTemplate with the supplied JobRequestMailTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestMailTemplate_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestMailTemplates/search": {
"post": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Search for JobRequestMailTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobRequestMailTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestMailTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestMailTemplates/searchIndex/{jobMailTemplateGuid}": {
"post": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Get index of a record in a search for jobgroup\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobRequestMailTemplates",
"parameters": [
{
"name": "jobMailTemplateGuid",
"in": "path",
"description": "The jobgroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestMailTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestMailTemplates/searchCount": {
"post": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Returns number of hits in a search for JobRequestMailTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobRequestMailTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestMailTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestMailTemplates/searchInfo": {
"get": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobRequestMailTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRequestMailTemplates/{jobMailTemplateNo}/copy": {
"get": {
"tags": [
"JobRequestMailTemplates"
],
"summary": "Copies an existing JobRequestMailTemplate to a new object",
"operationId": "CopyJobRequestMailTemplate",
"parameters": [
{
"name": "jobMailTemplateNo",
"in": "path",
"description": "The JobRequestMailTemplateNo of the jobMailTemplate to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new JobRequestMailTemplate object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestMailTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequests": {
"get": {
"tags": [
"JobRequests"
],
"summary": "Gets a list of JobRequests",
"operationId": "GetJobRequests",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"JobRequests"
],
"summary": "Creates a new jobRequest record",
"operationId": "CreateJobRequest",
"parameters": [
{
"name": "unitNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobRequest Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRequests/{jobRequestNo}": {
"get": {
"tags": [
"JobRequests"
],
"summary": "Gets a specific JobRequest",
"operationId": "GetJobRequest",
"parameters": [
{
"name": "jobRequestNo",
"in": "path",
"description": "the jobRequestNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobRequest",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobRequest with the supplied JobRequest No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"JobRequests"
],
"summary": "Updates an existing JobRequest",
"operationId": "UpdateJobRequest",
"parameters": [
{
"name": "jobRequestNo",
"in": "path",
"description": "The jobRequestNo of the jobRequest to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobRequest DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobRequest object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"JobRequests"
],
"summary": "Deletes an jobRequest record",
"parameters": [
{
"name": "jobRequestNo",
"in": "path",
"description": "The jobRequestNo of the JobRequest to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequest_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequests/{jobRequestNo}/history": {
"get": {
"tags": [
"JobRequests"
],
"summary": "Gets history for a specific JobRequest",
"operationId": "GetJobRequestHistory",
"parameters": [
{
"name": "jobRequestNo",
"in": "path",
"description": "The jobRequestNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobRequest",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobRequest with the supplied JobRequest No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequest_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequests/search": {
"post": {
"tags": [
"JobRequests"
],
"summary": "Search for jobRequests\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobRequests",
"parameters": [
{
"name": "unitNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequests/searchCount": {
"post": {
"tags": [
"JobRequests"
],
"summary": "Returns number of hits in a search for JobRequests\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobRequests",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequests/searchIndex/{jobRequestGuid}": {
"post": {
"tags": [
"JobRequests"
],
"summary": "Get index of a record in a search for JobRequests\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobRequests",
"parameters": [
{
"name": "jobRequestGuid",
"in": "path",
"description": "The jobRequest to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequests/searchInfo": {
"get": {
"tags": [
"JobRequests"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobRequests",
"parameters": [
{
"name": "unitNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRequests/submit": {
"post": {
"tags": [
"JobRequests"
],
"summary": "Creates a new jobRequest record",
"operationId": "CreateJobRequestWithFiles",
"parameters": [
{
"name": "unitNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRequests/{jobRequestNo}/copy": {
"get": {
"tags": [
"JobRequests"
],
"summary": "Copies an existing jobRequest to a new object",
"operationId": "CopyJobRequest",
"parameters": [
{
"name": "jobRequestNo",
"in": "path",
"description": "The JobRequestNo of the jobRequest to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new JobRequest object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequests/{jobRequestNo}/jobTemplate": {
"get": {
"tags": [
"JobRequests"
],
"summary": "Creates a Job (non-persisted) based on the Job Request with the provided Job Request No.",
"operationId": "CreateJobFromJobRequest",
"parameters": [
{
"name": "jobRequestNo",
"in": "path",
"description": "Job Request No. of the Job Request to base the Job on",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequests/tasklistNodes": {
"get": {
"tags": [
"JobRequests"
],
"summary": "Get jobrequest tasklist nodes",
"operationId": "GetJobRequestTasklistNodes",
"responses": {
"200": {
"description": "Returns all new job request tasklistnodes",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequests/search/{jobRequestTemplateNo}": {
"post": {
"tags": [
"JobRequests"
],
"summary": "Search for jobRequests using a specific Job Request Template\r\nTakes a Job Request Template No. and a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobRequestsByTemplateNo",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequest"
}
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRequests/searchInfo/{jobRequestTemplateNo}": {
"get": {
"tags": [
"JobRequests"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobRequestsByTemplateNo",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a list of valid search fields based on the given Job Request Template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRequests/searchCount/{jobRequestTemplateNo}": {
"post": {
"tags": [
"JobRequests"
],
"summary": "Returns number of hits in a search for JobRequests using a specific Job Request Template\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobRequestsByTemplateNo",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRequests/searchIndex/{jobRequestGuid}/{jobRequestTemplateNo}": {
"post": {
"tags": [
"JobRequests"
],
"summary": "Get index of a record in a search for JobRequests using a specific Job Request Template\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobRequestsByTemplateNo",
"parameters": [
{
"name": "jobRequestGuid",
"in": "path",
"description": "The jobRequest to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRequests/{jobRequestNo}/documents": {
"get": {
"tags": [
"JobRequests"
],
"summary": "Returns a list of Documents used on the Job Request",
"operationId": "GetJobRequestDocuments",
"parameters": [
{
"name": "jobRequestNo",
"in": "path",
"description": "The Job Request No to fetch documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the documents for the Job Requests",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequestDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequestDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequestDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequests/{jobRequestNo}/documents/{documentNo}": {
"get": {
"tags": [
"JobRequests"
],
"summary": "Returns a Documents used on the Job Request",
"operationId": "GetJobRequestDocument",
"parameters": [
{
"name": "jobRequestNo",
"in": "path",
"description": "The Job Request No to fetch documents for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the documents for the Job Requests",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequestDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequestDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequestDocument"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos": {
"get": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Gets a list of JobRequestTemplateLogos",
"operationId": "GetJobRequestTemplateLogos",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Creates a new document record",
"operationId": "CreateJobRequestTemplateLogo",
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/{documentNo}": {
"get": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Gets a specific JobRequestTemplateLogo",
"operationId": "GetJobRequestTemplateLogo",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "query",
"description": "The unit to lookup JobRequestTemplateLogo",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
},
"put": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Updates an existing Document",
"operationId": "UpdateJobRequestTemplateLogo",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/searchIndex/{documentGuid}": {
"post": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Get index of a record in a search for JobRequestTemplateLogo\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobRequestTemplateLogos",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/{documentNo}/history": {
"get": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Gets history for a specific JobRequestTemplateLogo",
"operationId": "GetJobRequestTemplateLogoHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/search": {
"post": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobRequestTemplateLogos",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/searchCount": {
"post": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobRequestTemplateLogos",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/searchInfo": {
"get": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobRequestTemplateLogos",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRequestTemplateLogos/{documentNo}/pdf": {
"get": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "",
"operationId": "GetJobRequestTemplateLogoPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/{documentNo}/file": {
"get": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "",
"operationId": "GetJobRequestTemplateLogoFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "query",
"description": "The unit to lookup JobRequestTemplateLogo file",
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
},
"post": {
"tags": [
"JobRequestTemplateLogos"
],
"operationId": "AddJobRequestTemplateLogosFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Get document pdf from guid",
"operationId": "GetJobRequestTemplateLogoPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Get document file from guid",
"operationId": "GetJobRequestTemplateLogoFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/{documentNo}/checkout": {
"put": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutJobRequestTemplateLogosFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/{documentNo}/checkin": {
"post": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "",
"operationId": "CheckinJobRequestTemplateLogoFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/{documentNo}/copy": {
"get": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyJobRequestTemplateLogo",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplateLogos/{documentNo}/usage": {
"get": {
"tags": [
"JobRequestTemplateLogos"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetJobRequestTemplateLogosUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates": {
"get": {
"tags": [
"JobRequestTemplates"
],
"summary": "Gets a list of JobRequestTemplates",
"operationId": "GetJobRequestTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
},
"post": {
"tags": [
"JobRequestTemplates"
],
"summary": "Creates a new jobRequestTemplate record",
"operationId": "CreateJobRequestTemplate",
"requestBody": {
"description": "The JobRequestTemplate Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/{jobRequestTemplateNo}": {
"get": {
"tags": [
"JobRequestTemplates"
],
"summary": "Gets a specific JobRequestTemplate",
"operationId": "GetJobRequestTemplate",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "the jobRequestTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "query",
"description": "The unit to lookup JobRequestTemplate",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobRequestTemplate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobRequestTemplate with the supplied JobRequestTemplate No cannot be found"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
},
"put": {
"tags": [
"JobRequestTemplates"
],
"summary": "Updates an existing JobRequestTemplate",
"operationId": "UpdateJobRequestTemplate",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "The jobRequestTemplateNo of the jobRequestTemplate to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobRequestTemplate DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobRequestTemplate object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"JobRequestTemplates"
],
"summary": "Deletes an jobRequestTemplate record",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "The jobRequestTemplateNo of the JobRequestTemplate to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/{jobRequestTemplateNo}/history": {
"get": {
"tags": [
"JobRequestTemplates"
],
"summary": "Gets history for a specific JobRequestTemplate",
"operationId": "GetJobRequestTemplateHistory",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "The jobRequestTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobRequestTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobRequestTemplate with the supplied JobRequestTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/search": {
"post": {
"tags": [
"JobRequestTemplates"
],
"summary": "Search for jobRequestTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobRequestTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/searchCount": {
"post": {
"tags": [
"JobRequestTemplates"
],
"summary": "Returns number of hits in a search for JobRequestTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobRequestTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/searchIndex/{jobRequestTemplateGuid}": {
"post": {
"tags": [
"JobRequestTemplates"
],
"summary": "Get index of a record in a search for JobRequestTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobRequestTemplates",
"parameters": [
{
"name": "jobRequestTemplateGuid",
"in": "path",
"description": "The jobRequestTemplate to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/searchInfo": {
"get": {
"tags": [
"JobRequestTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobRequestTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobRequestTemplates/{jobRequestTemplateNo}/copy": {
"get": {
"tags": [
"JobRequestTemplates"
],
"summary": "Copies an existing jobRequestTemplate to a new object",
"operationId": "CopyJobRequestTemplate",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "The JobRequestTemplateNo of the jobRequestTemplate to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new JobRequestTemplate object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/labels/{labelTemplateDocumentNo}": {
"post": {
"tags": [
"JobRequestTemplates"
],
"summary": "Gets the labels to print",
"operationId": "PrintJobRequestTemplateLabels",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "the template No to print",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A Search Definition containing the JobRequestTemplate numbers to print",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested JobRequestTemplate report as pdf"
},
"404": {
"description": "If a JobRequestTemplate with the supplied Job Request Template No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/labels/{labelTemplateDocumentNo}/{settingsKey}": {
"get": {
"tags": [
"JobRequestTemplates"
],
"summary": "Get the labels to print using ´settings key",
"operationId": "GetJobRequestTemplateLabelPdf",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "The template No to print",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "settingsKey",
"in": "path",
"description": "The UUID for the stored search definition",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/{jobRequestTemplateNo}/mailtemplates": {
"get": {
"tags": [
"JobRequestTemplates"
],
"summary": "Returns a list of mail templates used on job requests",
"operationId": "GetMailTemplates",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "The JobRequestTemplateno to fetch mail templates for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the mail templates for the job request template",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateJobRequestMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateJobRequestMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateJobRequestMailTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/{jobRequestTemplateNo}/mailtemplates/{jobRequestMailTemplateNo}": {
"get": {
"tags": [
"JobRequestTemplates"
],
"summary": "Returns a specific job request mail template",
"operationId": "GetMailTemplate",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "The JobRequestTemplateNo",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "jobRequestMailTemplateNo",
"in": "path",
"description": "The jobRequestMailTemplateNo to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the mail template for the job request template",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateJobRequestMailTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateJobRequestMailTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateJobRequestMailTemplate"
}
}
}
}
},
"404": {
"description": "If a mail template with the supplied JobRequestMailTemplateNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/{jobRequestTemplateNo}/createAnalyticsCustomTemplate/{templateName}": {
"post": {
"tags": [
"JobRequestTemplates"
],
"operationId": "JobRequestTemplate_CreateCustomAnalyticsTemplate",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "templateName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_GenerateAnalyticsView | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/{jobRequestTemplateNo}/updateAnalyticsCustomTemplate/{templateNo}": {
"put": {
"tags": [
"JobRequestTemplates"
],
"operationId": "JobRequestTemplate_UpdateCustomAnalyticsTemplate",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "templateNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate_GenerateAnalyticsView | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobRequestTemplates/{jobRequestTemplateNo}/notificationusers": {
"get": {
"tags": [
"JobRequestTemplates"
],
"summary": "Returns a list of notification users used on job requests",
"operationId": "GetNotificationUsers",
"parameters": [
{
"name": "jobRequestTemplateNo",
"in": "path",
"description": "The JobRequestTemplateNo to fetch notification users for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the notification users for the job request template",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateNotificationUser"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateNotificationUser"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateNotificationUser"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobRequestTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobResponsibles": {
"get": {
"tags": [
"JobResponsibles"
],
"summary": "Gets a list of Job Responsibles",
"operationId": "GetJobResponsibles",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobResponsibles/{resourceNo}": {
"get": {
"tags": [
"JobResponsibles"
],
"summary": "Gets a specific Job Responsible",
"operationId": "GetJobResponsible",
"parameters": [
{
"name": "resourceNo",
"in": "path",
"description": "The ResourceNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested resource",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an resource with the supplied Resource No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobResponsibles/search": {
"post": {
"tags": [
"JobResponsibles"
],
"summary": "Search for Job Responsibles\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobResponsibles",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested resource",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobResponsibles/searchIndex/{resourceGuid}": {
"post": {
"tags": [
"JobResponsibles"
],
"summary": "Get index of a record in a search for Job Resposibles\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobResponsibles",
"parameters": [
{
"name": "resourceGuid",
"in": "path",
"description": "The resource to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobResponsibles/searchCount": {
"post": {
"tags": [
"JobResponsibles"
],
"summary": "Returns number of hits in a search for Job Responsibles\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobResponsibles",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobResponsibles/searchInfo": {
"get": {
"tags": [
"JobResponsibles"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobResponsibles",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Jobs": {
"get": {
"tags": [
"Jobs"
],
"summary": "Gets a list of Jobs",
"operationId": "GetJobs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Jobs"
],
"summary": "Creates a new job record",
"operationId": "CreateJob",
"requestBody": {
"description": "The Job Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_Update | Update |
| Job_CreateRunOnceJob | CreateRunOnceJob |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/search/{keyword}": {
"get": {
"tags": [
"Jobs"
],
"operationId": "SearchJobs",
"parameters": [
{
"name": "keyword",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/search": {
"post": {
"tags": [
"Jobs"
],
"summary": "Advanced search for jobs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "AdvancedSearchJobs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/searchCount": {
"post": {
"tags": [
"Jobs"
],
"summary": "Search for Jobs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobs",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/searchIndex/{jobGuid}": {
"post": {
"tags": [
"Jobs"
],
"summary": "Get index of a record in a search for Jobs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobs",
"parameters": [
{
"name": "jobGuid",
"in": "path",
"description": "The job to find index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/searchInfo": {
"get": {
"tags": [
"Jobs"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "JobSearchInfo",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Jobs/{jobNo}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Gets a specific Job",
"operationId": "GetJob",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The JobNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested job",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a job with the supplied Job No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Jobs"
],
"summary": "Updates an existing Job",
"operationId": "UpdateJob",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The JobNo of the job to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Job DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Job object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_Update | Update |
| Job_CreateRunOnceJob | CreateRunOnceJob |
| Job_UpdateReferences | UpdateReferences |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Jobs"
],
"summary": "Deletes a job record",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The JobNo of the Job to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/history": {
"get": {
"tags": [
"Jobs"
],
"summary": "Gets history for a specific Job",
"operationId": "GetHistoryForJob",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The JobNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an job with the supplied Job No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/JobReports": {
"get": {
"tags": [
"Jobs"
],
"summary": "",
"operationId": "GetJobReportsFromUserSettings",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested job report as pdf"
},
"404": {
"description": "If a job with the supplied Job No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNos}/JobReports": {
"get": {
"tags": [
"Jobs"
],
"summary": "",
"operationId": "GetJobReports",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "jobNos",
"in": "path",
"description": "A comma separated list of job numbers to report",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested job report as pdf"
},
"404": {
"description": "If a job with the supplied Job No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/JobReport": {
"get": {
"tags": [
"Jobs"
],
"summary": "",
"operationId": "GetJobReport",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "jobNo",
"in": "path",
"description": "The job no to report",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested job report as pdf"
},
"404": {
"description": "If a job with the supplied Job No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/ActivateJobs": {
"post": {
"tags": [
"Jobs"
],
"summary": "Activates all the jobs in the job list",
"operationId": "ActivateJobs",
"requestBody": {
"description": "A list of job no's to activate",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns a Job Activation Result with information about the activated jobs",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobActivationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobActivationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobActivationResult"
}
}
}
},
"400": {
"description": "Returns a Job Activation Result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobActivationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobActivationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobActivationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobHistory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/DeactivateJobs": {
"post": {
"tags": [
"Jobs"
],
"summary": "Deactivates all the jobs in the job list",
"operationId": "DeactivateJobs",
"requestBody": {
"description": "A list of job no's to deactivate",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns a Job Deactivation Result with information about the deactivated jobs",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDeactivationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDeactivationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDeactivationResult"
}
}
}
},
"400": {
"description": "Returns a Job Deactivation Result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDeactivationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDeactivationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDeactivationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobHistory_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/FinalizeJobs": {
"post": {
"tags": [
"Jobs"
],
"summary": "Finalizes all the jobs in the job list",
"operationId": "FinalizeJobs",
"requestBody": {
"description": "A list of job no's to finalize",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns a Job Deactivation Result with information about the deactivated jobs",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
}
}
},
"400": {
"description": "Returns a Job Deactivation Result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobHistory_Finalize | Finalize |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/force": {
"delete": {
"tags": [
"Jobs"
],
"summary": "Force deletes a job record\r\nForce deleting records may cause existing records to contain invalid data, that needs adjustment before they can be saved",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The JobNo of the Job to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/resources": {
"get": {
"tags": [
"Jobs"
],
"summary": "Fetches all Resources attached to the job",
"operationId": "GetJobResources",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch resources for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the resources for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobResource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/items": {
"get": {
"tags": [
"Jobs"
],
"summary": "Returns a list of Items used to perform the Job",
"operationId": "GetJobItems",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch items for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/procedures": {
"get": {
"tags": [
"Jobs"
],
"summary": "Returns a list of procedures used to perform the Job",
"operationId": "GetJobProcedures",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch procedures for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the procedures for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobProcedure"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobProcedure"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobProcedure"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/triggers": {
"get": {
"tags": [
"Jobs"
],
"summary": "Returns a list of Items used to perform the Job",
"operationId": "GetTriggers",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch triggers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the triggers for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/triggers/longDescription": {
"post": {
"tags": [
"Jobs"
],
"summary": "Returns a specific job trigger",
"operationId": "GetTriggerLongDescription",
"requestBody": {
"description": "The trigger to get long description from",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobTrigger"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobTrigger"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobTrigger"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobTrigger"
}
}
}
},
"responses": {
"200": {
"description": "Returns the description for the trigger",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobTrigger"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobTrigger"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobTrigger"
}
}
}
},
"404": {
"description": "If no valid data was set"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/documents": {
"get": {
"tags": [
"Jobs"
],
"summary": "Returns a list of Documents used on the Job",
"operationId": "GetJobDocuments",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch triggers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the triggers for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/jobgroups": {
"get": {
"tags": [
"Jobs"
],
"summary": "Fetches all JobGroups attached to the job",
"operationId": "GetJobJobGroups",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch jobgroups for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the jobgroups for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobJobGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobJobGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobJobGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/notifications": {
"get": {
"tags": [
"Jobs"
],
"summary": "Fetches all Notifications attached to the job",
"operationId": "GetJobNotifications",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch resources for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the resources for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobNotification"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobNotification"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobNotification"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/formTemplates": {
"get": {
"tags": [
"Jobs"
],
"summary": "Fetches all FormTemplates attached to the job",
"operationId": "GetJobFormTemplates",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch formTemplates for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the formTemplates for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/formTemplates/createForm": {
"post": {
"tags": [
"Jobs"
],
"summary": "Creates a Form based on the supplied JobFormTemplate object",
"operationId": "CreateJobFormTemplateForm",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno which FormTemplate belongs to",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Job formTemplate reference to create form for",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the JobFormTemplate after form is created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/copy": {
"get": {
"tags": [
"Jobs"
],
"summary": "Copies an existing Job to a new object",
"operationId": "CopyJob",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The JobNo of the job to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Job object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/finalizerunoncejob": {
"post": {
"tags": [
"Jobs"
],
"summary": "Creates a new run once job record with a finalized job history",
"operationId": "FinalizeRunOnceJob",
"requestBody": {
"description": "The Job Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_Update | Update |
| Job_CreateRunOnceJob | CreateRunOnceJob |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/jobs/{jobNo}/sendtoemail": {
"post": {
"tags": [
"Jobs"
],
"summary": "Send job to supplier",
"operationId": "SendToEmail",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobMail DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobMail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobMail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobMail"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobMail"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/jobmailattachments": {
"get": {
"tags": [
"Jobs"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetAttachmentsFor",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The JobNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobMailAttachmentView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobMailAttachmentView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobMailAttachmentView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/jobs/{jobNo}/postpone": {
"post": {
"tags": [
"Jobs"
],
"summary": "Postpone a Job",
"operationId": "JobPostpone",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobPostponementInfo DTO",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AllowPostponeJob | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/jobs/{jobNo}/approvepostpone": {
"post": {
"tags": [
"Jobs"
],
"summary": "Approve Postponement of a Job",
"operationId": "JobApprovePostpone",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The remark",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AllowJobPostponementApproval | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/jobs/{jobNo}/rejectpostpone": {
"post": {
"tags": [
"Jobs"
],
"summary": "Reject Postponement of a Job",
"operationId": "JobRejectPostpone",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The remark",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPostponementInfo"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AllowJobPostponementApproval | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/jobs/{jobNo}/move": {
"post": {
"tags": [
"Jobs"
],
"summary": "Move a Job to another component",
"operationId": "JobMove",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The JobNo to move",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobMoveInfo DTO",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobMoveInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobMoveInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobMoveInfo"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobMoveInfo"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_MoveToAnotherComponent | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/appRequest": {
"post": {
"tags": [
"Jobs"
],
"summary": "Get Job Lists for App",
"operationId": "JobAppRequest",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobListAppObject"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobListAppObject"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobListAppObject"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/appRequest/checksum": {
"post": {
"tags": [
"Jobs"
],
"summary": "Get checksum of Job Lists for App",
"operationId": "JobAppRequestChecksum",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/appSubmit": {
"post": {
"tags": [
"Jobs"
],
"summary": "Receive a new Job from new Job App or updates GPS on an existing Job",
"operationId": "ReceiveJob",
"requestBody": {
"description": "The Job to Receive",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobAppObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobAppObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobAppObject"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobAppObject"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_Update | Update |
| Job_CreateRunOnceJob | CreateRunOnceJob |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/relatedjobs": {
"get": {
"tags": [
"Jobs"
],
"summary": "Returns an ordered list of related Jobs",
"operationId": "GetRelatedJobs",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/appRequest/showJobsOnMapTemplate": {
"get": {
"tags": [
"Jobs"
],
"summary": "Returns a string with the HTML of the template used to show Jobs on a map",
"operationId": "JobAppRequestShowJobsOnMapTemplate",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/documents/{documentNo}/pdf": {
"get": {
"tags": [
"Jobs"
],
"operationId": "GetDocumentPdfForJob",
"parameters": [
{
"name": "jobNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/documents/{documentNo}/file": {
"get": {
"tags": [
"Jobs"
],
"operationId": "GetDocumentFileForJob",
"parameters": [
{
"name": "jobNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/assignees": {
"get": {
"tags": [
"Jobs"
],
"summary": "Fetches all Assigned to current instance of job",
"operationId": "GetAssignees",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch resources for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the resources for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/assignees": {
"post": {
"tags": [
"Jobs"
],
"summary": "Gets all assignees for all job instances",
"operationId": "GetAllAssignees",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Jobs"
],
"summary": "",
"operationId": "UpdateAssignees",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPlanningUpdateResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPlanningUpdateResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobPlanningUpdateResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/resource/{resourceNo}/assignees": {
"post": {
"tags": [
"Jobs"
],
"summary": "Fetches all Resource Assignees",
"operationId": "GetResourceAssignees",
"parameters": [
{
"name": "resourceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/propertyDefinitions": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get a list of PropertyDefinitions",
"operationId": "GetJobPropertyDefinitions",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Jobs"
],
"summary": "Creates a new PropertyDefinition record",
"operationId": "CreateJobPropertyDefinition",
"requestBody": {
"description": "The PropertyDefinition DTO object to create",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/propertyDefinitions/{propertyDefinitionGuid}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Gets a specific PropertyDefinition",
"operationId": "GetJobPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested PropertyDefinition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an GetPropertyDefinition with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Jobs"
],
"summary": "Updates an existing PropertyDefinition",
"operationId": "UpdateJobPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The PropertyDefinition DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PropertyDefinition object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Jobs"
],
"summary": "Deletes a PropertyDefinition record",
"operationId": "DeleteJobPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/propertyDefinitions/{propertyDefinitionGuid}/listValues": {
"get": {
"tags": [
"Jobs"
],
"summary": "Returns a list of values for a PropertyDefinition",
"operationId": "GetJobPropertyDefinitionListValues",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The PropertyDefinition Guid to fetch values for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "textFilter",
"in": "query",
"description": "(optional) text filter",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the values for the ListOfValuesTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/propertyDefinitions/{propertyDefinitionGuid}/force": {
"delete": {
"tags": [
"Jobs"
],
"summary": "Force Deletes a PropertyDefinition record",
"operationId": "ForceDeleteJobPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/propertyDefinitions/{propertyName}/available": {
"get": {
"tags": [
"Jobs"
],
"summary": "Lookup if PropertyName of a PropertyDefinition is not already in use and therefore available to be used",
"operationId": "JobPropertyNameAvailable",
"parameters": [
{
"name": "propertyName",
"in": "path",
"description": "The propertyName to check",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns true is property name is available to be used",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/screenLayout": {
"post": {
"tags": [
"Jobs"
],
"summary": "Bulk updates screenlayout and a list of Property Definitions. The endpoint handles whether or not to create or update each record in the requst.",
"operationId": "BulkUpdateJobScreenLayout",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/managementSystemDocuments/preview": {
"get": {
"tags": [
"Jobs"
],
"summary": "Returns a combined preview of the Management System Documents selected for preview on the given job.",
"operationId": "GetManagementSystemDocumentsPreview",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "The Jobno to fetch from",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ManagementSystemOnJob |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/BatchEdit": {
"post": {
"tags": [
"Jobs"
],
"operationId": "JobBatchEdit",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEdit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEdit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEdit"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEdit"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_AllowBatchEditing | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/BatchEdit/ApplyTransformations/{jobNo}": {
"post": {
"tags": [
"Jobs"
],
"operationId": "JobBatchEditApplyTransformations",
"parameters": [
{
"name": "jobNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_AllowBatchEditing | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/webhooklogs/search": {
"post": {
"tags": [
"Jobs"
],
"summary": "Searches the Webhooks associated with the Job.",
"operationId": "SearchJobWebhookLogs",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| WebhooksIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/webhooklogs/searchCount": {
"post": {
"tags": [
"Jobs"
],
"summary": "Returns number of hits in a search for the Job's Webhook Logs.\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobWebhookLogsCount",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/webhooklogs/{webhookLogGuid}/retransmit": {
"post": {
"tags": [
"Jobs"
],
"summary": "Retransmits a specific Webhook based on the selected Webhook Log.",
"operationId": "RetransmitJobWebhookLog",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookLogGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/webhooklogs/{webhookLogGuid}/resolve": {
"post": {
"tags": [
"Jobs"
],
"summary": "Resolves a specific Webhook Log with a Response Log entry.",
"operationId": "ResolveJobWebhookLog",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookLogGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/markasread": {
"post": {
"tags": [
"Jobs"
],
"summary": "",
"operationId": "MarkAsRead",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/markasunread": {
"post": {
"tags": [
"Jobs"
],
"summary": "",
"operationId": "MarkAsUnread",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/acknowledge": {
"post": {
"tags": [
"Jobs"
],
"summary": "",
"operationId": "Acknowledge",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/disable": {
"post": {
"tags": [
"Jobs"
],
"summary": "Disable the job for the provided jobNo",
"operationId": "DisableJob",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableArguments"
}
}
}
},
"responses": {
"200": {
"description": "Returns a Job Disable Result with information about the disabled job",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
}
}
},
"400": {
"description": "Returns a Job Disable Result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_AllowDisableJob | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Jobs/{jobNo}/enable": {
"post": {
"tags": [
"Jobs"
],
"summary": "Enables the job for the provided jobNo",
"operationId": "EnableJob",
"parameters": [
{
"name": "jobNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Arguments from the body",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisableResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Job_AllowDisableJob | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobSequences": {
"get": {
"tags": [
"JobSequences"
],
"summary": "Gets a list of JobSequences",
"operationId": "GetJobSequences",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"JobSequences"
],
"summary": "Creates a new jobSequence record",
"operationId": "CreateJobSequence",
"requestBody": {
"description": "The JobSequence Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobSequence_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobSequences/{jobSequenceNo}": {
"get": {
"tags": [
"JobSequences"
],
"summary": "Gets a specific JobSequence",
"operationId": "GetJobSequence",
"parameters": [
{
"name": "jobSequenceNo",
"in": "path",
"description": "the jobSequenceNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobSequence",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobSequence with the supplied JobSequence No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"JobSequences"
],
"summary": "Updates an existing JobSequence",
"operationId": "UpdateJobSequence",
"parameters": [
{
"name": "jobSequenceNo",
"in": "path",
"description": "The jobSequenceNo of the jobSequence to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobSequence DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobSequence object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobSequence_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"JobSequences"
],
"summary": "Deletes an jobSequence record",
"parameters": [
{
"name": "jobSequenceNo",
"in": "path",
"description": "The jobSequenceNo of the JobSequence to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobSequence_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobSequences/{jobSequenceNo}/history": {
"get": {
"tags": [
"JobSequences"
],
"summary": "Gets history for a specific JobSequence",
"operationId": "GetJobSequenceHistory",
"parameters": [
{
"name": "jobSequenceNo",
"in": "path",
"description": "The jobSequenceNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested jobSequence",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an jobSequence with the supplied JobSequence No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobSequence_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobSequences/search": {
"post": {
"tags": [
"JobSequences"
],
"summary": "Search for jobSequences\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobSequences",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobSequences/searchCount": {
"post": {
"tags": [
"JobSequences"
],
"summary": "Returns number of hits in a search for JobSequences\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobSequences",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobSequences/searchIndex/{jobSequenceGuid}": {
"post": {
"tags": [
"JobSequences"
],
"summary": "Get index of a record in a search for JobSequences\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobSequences",
"parameters": [
{
"name": "jobSequenceGuid",
"in": "path",
"description": "The jobSequence to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobSequences/searchInfo": {
"get": {
"tags": [
"JobSequences"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobSequences",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobSequences/{jobSequenceNo}/copy": {
"get": {
"tags": [
"JobSequences"
],
"summary": "Copies an existing jobSequence to a new object",
"operationId": "CopyJobSequence",
"parameters": [
{
"name": "jobSequenceNo",
"in": "path",
"description": "The JobSequenceNo of the jobSequence to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new JobSequence object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequence"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobSequence_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobSequences/{jobSequenceNo}/jobs": {
"get": {
"tags": [
"JobSequences"
],
"summary": "Fetches all Jobs attached to the job sequence",
"operationId": "GetJobSequenceJobs",
"parameters": [
{
"name": "jobSequenceNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the resources for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequenceJob"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequenceJob"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequenceJob"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobSequences/{jobNo}/triggers/{triggerGuid}": {
"get": {
"tags": [
"JobSequences"
],
"summary": "Gets a specific Trigger for a Job Sequence Job.",
"operationId": "GetJobSequenceJobTrigger",
"parameters": [
{
"name": "jobNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "triggerGuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Trigger",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequenceJobTrigger"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequenceJobTrigger"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequenceJobTrigger"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Trigger with the supplied Trigger Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates": {
"get": {
"tags": [
"JobTemplates"
],
"summary": "Gets a list of JobTemplates",
"operationId": "GetJobTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"JobTemplates"
],
"summary": "Creates a new JobTemplate record",
"operationId": "CreateJobTemplate",
"requestBody": {
"description": "The JobTemplate Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates/{JobTemplateNo}": {
"get": {
"tags": [
"JobTemplates"
],
"summary": "Gets a specific JobTemplate",
"operationId": "GetJobTemplate",
"parameters": [
{
"name": "JobTemplateNo",
"in": "path",
"description": "The JobTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested JobTemplate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an JobTemplate with the supplied JobTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"JobTemplates"
],
"summary": "Updates an existing JobTemplate",
"operationId": "UpdateJobTemplate",
"parameters": [
{
"name": "JobTemplateNo",
"in": "path",
"description": "The JobTemplateNo of the JobTemplate to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JobTemplate DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated JobTemplate object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"JobTemplates"
],
"summary": "Deletes a JobTemplate record",
"parameters": [
{
"name": "JobTemplateNo",
"in": "path",
"description": "The JobTemplateNo of the JobTemplate to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobTemplate_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates/{JobTemplateNo}/history": {
"get": {
"tags": [
"JobTemplates"
],
"summary": "Gets history for a specific JobTemplate",
"operationId": "GetJobTemplateHistory",
"parameters": [
{
"name": "JobTemplateNo",
"in": "path",
"description": "The JobTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested JobTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an JobTemplate with the supplied JobTemplate No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobTemplate_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates/search": {
"post": {
"tags": [
"JobTemplates"
],
"summary": "Search for JobTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchJobTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobTemplate | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates/searchIndex/{JobTemplateGuid}": {
"post": {
"tags": [
"JobTemplates"
],
"summary": "Get index of a record in a search for JobTemplate\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexJobTemplates",
"parameters": [
{
"name": "JobTemplateGuid",
"in": "path",
"description": "The JobTemplate to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates/searchCount": {
"post": {
"tags": [
"JobTemplates"
],
"summary": "Returns number of hits in a search for JobTemplates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountJobTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates/searchInfo": {
"get": {
"tags": [
"JobTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoJobTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/JobTemplates/{JobTemplateNo}/copy": {
"get": {
"tags": [
"JobTemplates"
],
"summary": "Copies an existing JobTemplate to a new object",
"operationId": "CopyJobTemplate",
"parameters": [
{
"name": "JobTemplateNo",
"in": "path",
"description": "The JobTemplateNo of the JobTemplate to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new JobTemplate object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates/{templateNo}/jobgroups": {
"get": {
"tags": [
"JobTemplates"
],
"summary": "Fetches a all JobGroups attached to the job template",
"operationId": "GetJobTemplateJobGroups",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "The Jobno to fetch jobgroups for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the jobgroups for the job",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplateJobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplateJobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplateJobGroup"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobTemplate | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates/{templateNo}/jobgroups/{jobgroupNo}": {
"get": {
"tags": [
"JobTemplates"
],
"summary": "Fetches a specific JobGroup attached to the job template",
"operationId": "GetJobTemplateJobGroup",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "The templateNo to fetch jobgroups for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "jobgroupNo",
"in": "path",
"description": "The jobgroup no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the jobgroups for the job",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobJobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobJobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobJobGroup"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobTemplate | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates/{templateNo}/resources": {
"get": {
"tags": [
"JobTemplates"
],
"summary": "Fetches a all Resources attached to the job template",
"operationId": "GetJobTemplateResources",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "The templateNo to fetch resources for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the resources for the job template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplateJobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplateJobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplateJobGroup"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobTemplate | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/JobTemplates/{templateNo}/resources/{resourceNo}": {
"get": {
"tags": [
"JobTemplates"
],
"summary": "Fetches a specific Resource attached to the Job Template",
"operationId": "GetJobTemplateResource",
"parameters": [
{
"name": "templateNo",
"in": "path",
"description": "The templateNo to fetch resources for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resourceNo",
"in": "path",
"description": "The resource no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Resource for the job template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobJobGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobJobGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobJobGroup"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| JobTemplate | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/License": {
"get": {
"tags": [
"License"
],
"operationId": "GetAllLicenseValues",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.License.License"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.License.License"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.License.License"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/License/{licenseKey}": {
"get": {
"tags": [
"License"
],
"operationId": "GetSingleLicenseValue",
"parameters": [
{
"name": "licenseKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/License/RequiredAppVersion/{appId}": {
"get": {
"tags": [
"License"
],
"operationId": "GetRequiredAppVersion",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/License/validate": {
"get": {
"tags": [
"License"
],
"operationId": "ValidateLicense",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Licensing.LicenseValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Licensing.LicenseValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Licensing.LicenseValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Licensing.LicenseValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Licensing.LicenseValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Licensing.LicenseValidationResult"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LiquidTypes": {
"get": {
"tags": [
"LiquidTypes"
],
"summary": "Gets a list of LiquidTypes",
"operationId": "GetLiquidTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"LiquidTypes"
],
"summary": "Creates a new LiquidType record",
"operationId": "CreateLiquidType",
"requestBody": {
"description": "The LiquidType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LiquidType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LiquidTypes/{liquidTypeNo}": {
"get": {
"tags": [
"LiquidTypes"
],
"summary": "Gets a specific LiquidType",
"operationId": "GetLiquidType",
"parameters": [
{
"name": "liquidTypeNo",
"in": "path",
"description": "The LiquidTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested liquidType",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an liquidType with the supplied liquidType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"LiquidTypes"
],
"summary": "Updates an existing LiquidType",
"operationId": "UpdateLiquidType",
"parameters": [
{
"name": "liquidTypeNo",
"in": "path",
"description": "The LiquidTypeNo of the liquidType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The LiquidType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated LiquidType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LiquidType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"LiquidTypes"
],
"summary": "Deletes a LiquidType record",
"parameters": [
{
"name": "liquidTypeNo",
"in": "path",
"description": "The LiquidTypeNo of the LiquidType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LiquidType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LiquidTypes/{liquidTypeNo}/history": {
"get": {
"tags": [
"LiquidTypes"
],
"summary": "Gets history for a specific LiquidType",
"operationId": "GetLiquidTypeHistory",
"parameters": [
{
"name": "liquidTypeNo",
"in": "path",
"description": "The LiquidTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Returns the requested LiquidType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an LiquidType with the supplied LiquidType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LiquidType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LiquidTypes/search": {
"post": {
"tags": [
"LiquidTypes"
],
"summary": "Search for LiquidType\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchLiquidTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested liquidType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LiquidTypes/searchIndex/{liquidType}": {
"post": {
"tags": [
"LiquidTypes"
],
"summary": "Get index of a record in a search for liquidTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexliquidType",
"parameters": [
{
"name": "liquidTypeGuid",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "liquidType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LiquidTypes/searchCount": {
"post": {
"tags": [
"LiquidTypes"
],
"summary": "Returns number of hits in a search for liquidTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountLiquidTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LiquidTypes/searchInfo": {
"get": {
"tags": [
"LiquidTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoLiquidTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LiquidTypes/{liquidTypeNo}/copy": {
"get": {
"tags": [
"LiquidTypes"
],
"summary": "Copies an existing LiquidType to a new object",
"operationId": "CopyLiquidType",
"parameters": [
{
"name": "liquidTypeNo",
"in": "path",
"description": "The LiquidTypeNo of the LiquidType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new LiquidType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LiquidType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LiquidType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationLanguages": {
"get": {
"tags": [
"LocalizationLanguages"
],
"summary": "Gets a list of LocalizationLanguages",
"operationId": "GetLocalizationLanguages",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"LocalizationLanguages"
],
"operationId": "CreateLanguage",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationLanguage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationLanguages/{localizationLanguageNo}": {
"get": {
"tags": [
"LocalizationLanguages"
],
"summary": "Gets a specific LocalizationLanguage",
"operationId": "GetLocalizationLanguage",
"parameters": [
{
"name": "localizationLanguageNo",
"in": "path",
"description": "The LocalizationLanguageNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested localizationLanguage",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an localizationLanguage with the supplied LocalizationLanguage No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationLanguages/search": {
"post": {
"tags": [
"LocalizationLanguages"
],
"summary": "Search for LocalizationLanguages\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchLocalizationLanguages",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationLanguage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationLanguages/searchCount": {
"post": {
"tags": [
"LocalizationLanguages"
],
"summary": "Returns number of hits in a search for LocalizationLanguages\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountLocalizationLanguages",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationLanguage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationLanguages/searchIndex/{localizationLanguagesGuid}": {
"post": {
"tags": [
"LocalizationLanguages"
],
"summary": "Get index of a record in a search for LocalizationLanguages\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexLocalizationLanguages",
"parameters": [
{
"name": "localizationLanguagesGuid",
"in": "path",
"description": "The localizationLanguages to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationLanguage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationLanguages/searchInfo": {
"get": {
"tags": [
"LocalizationLanguages"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoLocalizationLanguages",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LocalizationLanguages/{languageNo}": {
"put": {
"tags": [
"LocalizationLanguages"
],
"operationId": "UpdateLanguage",
"parameters": [
{
"name": "languageNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationLanguage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"LocalizationLanguages"
],
"parameters": [
{
"name": "languageNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationLanguage_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationLanguages/{localizationLanguageNo}/rootLanguage": {
"get": {
"tags": [
"LocalizationLanguages"
],
"operationId": "GetLocalizationLanguageRoot",
"parameters": [
{
"name": "localizationLanguageNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LocalizationTexts": {
"get": {
"tags": [
"LocalizationTexts"
],
"summary": "",
"operationId": "GetLocalizationTexts",
"responses": {
"200": {
"description": "Returns the all localization texts for the current user's language",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a language cannot be found for the user"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"LocalizationTexts"
],
"summary": "Creates a new localizationText record",
"operationId": "CreateLocalizationText",
"requestBody": {
"description": "The LocalizationText object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationText_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationTexts/currentLanguage/{textID}": {
"get": {
"tags": [
"LocalizationTexts"
],
"summary": "",
"operationId": "GetLocalizationTextsForCurrentLanguage",
"parameters": [
{
"name": "textID",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Returns the requested localizationText",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a localizationText with the supplied text id cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationTexts/{guid}": {
"get": {
"tags": [
"LocalizationTexts"
],
"summary": "",
"operationId": "GetLocalizationTextByGuid",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid of the LocalizationText to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested localizationText",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a localizationText with the supplied text id cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationTexts/language/{languageID}": {
"get": {
"tags": [
"LocalizationTexts"
],
"summary": "",
"operationId": "GetLocalizationTextsForLanguage",
"parameters": [
{
"name": "languageID",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the all localization texts for the supplied language",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a localizationLanguage with the supplied Language ID cannot be found"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LocalizationTexts/language/{languageID}/{textID}": {
"get": {
"tags": [
"LocalizationTexts"
],
"summary": "",
"operationId": "GetLocalizationTextForLanguage",
"parameters": [
{
"name": "languageID",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "textID",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Returns the requested localizationText",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.LocalizationText"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a localizationText with the supplied text id cannot be found"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LocalizationTexts/search/{toLanguageNo}": {
"post": {
"tags": [
"LocalizationTexts"
],
"summary": "Search for LocalizationTexts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchLocalizationTextsWithTranslatedValues",
"parameters": [
{
"name": "toLanguageNo",
"in": "path",
"description": "The Language to look for translated values in",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationText | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationTexts/searchInfo": {
"get": {
"tags": [
"LocalizationTexts"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoLocalizationTexts",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LocalizationTexts/search": {
"post": {
"tags": [
"LocalizationTexts"
],
"summary": "Search for LocalizationTexts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchLocalizationTexts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationText | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationTexts/searchCount": {
"post": {
"tags": [
"LocalizationTexts"
],
"summary": "Returns number of hits in a search for LocalizationTexts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountLocalizationTexts",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationText | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationTexts/translation/{languageID}/{textID}": {
"get": {
"tags": [
"LocalizationTexts"
],
"summary": "",
"operationId": "GetTranslationTextForLanguage",
"parameters": [
{
"name": "languageID",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "textID",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Returns the requested localizationText",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a localizationText with the supplied text id cannot be found"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LocalizationTexts/reloadTextCache": {
"post": {
"tags": [
"LocalizationTexts"
],
"operationId": "ReloadTextCache",
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationText_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationTexts/{textGuid}": {
"put": {
"tags": [
"LocalizationTexts"
],
"summary": "Updates a LocalizationText record",
"operationId": "UpdateLocalizationText",
"parameters": [
{
"name": "textGuid",
"in": "path",
"description": "The guid of the localizationText to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The LocalizationText DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationText_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"LocalizationTexts"
],
"summary": "Deletes a LocalizationText record",
"parameters": [
{
"name": "textGuid",
"in": "path",
"description": "The TextId of the localizationText to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationText_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LocalizationTexts/{textId}/references": {
"get": {
"tags": [
"LocalizationTexts"
],
"summary": "Gets LocalizationTexts references",
"operationId": "GetReferences",
"parameters": [
{
"name": "textId",
"in": "path",
"description": "The textId of the LocalizationText to get references for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.TranslationText"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LocalizationText | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Log": {
"get": {
"tags": [
"Log"
],
"summary": "Gets a list of Log Entries",
"operationId": "GetLogEntries",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Log/{logEntryGuid}": {
"get": {
"tags": [
"Log"
],
"summary": "Gets a specific LogEntry",
"operationId": "GetLogEntry",
"parameters": [
{
"name": "logEntryGuid",
"in": "path",
"description": "The LogEntry Guid to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested LogEntry",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a log entry with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Log/search": {
"post": {
"tags": [
"Log"
],
"summary": "Search for LogEntries\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchLogEntries",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested log entries",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Log/searchIndex/{logEntryGuid}": {
"post": {
"tags": [
"Log"
],
"summary": "Get index of a record in a search for logEntries\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexLogEntries",
"parameters": [
{
"name": "logEntryGuid",
"in": "path",
"description": "The Log Entry to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Log/searchCount": {
"post": {
"tags": [
"Log"
],
"summary": "Returns number of hits in a search for LogEntries\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountLogEntries",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Log/searchInfo": {
"get": {
"tags": [
"Log"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoLogEntries",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Log/error": {
"post": {
"tags": [
"Log"
],
"operationId": "LogError",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Log/critical": {
"post": {
"tags": [
"Log"
],
"operationId": "LogCritical",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Log/warning": {
"post": {
"tags": [
"Log"
],
"operationId": "LogWarning",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Log/information": {
"post": {
"tags": [
"Log"
],
"operationId": "LogInformation",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Log/debug": {
"post": {
"tags": [
"Log"
],
"operationId": "LogDebug",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Log/trace": {
"post": {
"tags": [
"Log"
],
"operationId": "LogTrace",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.LogEntry"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LogbookDocuments": {
"get": {
"tags": [
"LogbookDocuments"
],
"summary": "Gets a list of LogbookDocuments",
"operationId": "GetLogbookDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook | View |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"LogbookDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateLogbookDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookDocuments/{documentNo}": {
"get": {
"tags": [
"LogbookDocuments"
],
"summary": "Gets a specific LogbookDocument",
"operationId": "GetLogbookDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook | View |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"LogbookDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook_Delete | Delete |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"LogbookDocuments"
],
"summary": "Get index of a record in a search for LogbookDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexLogbookDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook | View |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookDocuments/{documentNo}/history": {
"get": {
"tags": [
"LogbookDocuments"
],
"summary": "Gets history for a specific LogbookDocument",
"operationId": "GetLogbookDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook_HistoryMode | HistoryMode |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookDocuments/search": {
"post": {
"tags": [
"LogbookDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchLogbookDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook | View |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookDocuments/searchCount": {
"post": {
"tags": [
"LogbookDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountLogbookDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook | View |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookDocuments/searchInfo": {
"get": {
"tags": [
"LogbookDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoLogbookDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LogbookDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"LogbookDocuments"
],
"summary": "",
"operationId": "GetLogbookDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook | View |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookDocuments/{documentNo}/file": {
"get": {
"tags": [
"LogbookDocuments"
],
"summary": "",
"operationId": "GetLogbookDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook | View |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"LogbookDocuments"
],
"operationId": "AddLogbookDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"LogbookDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetLogbookDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook | View |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"LogbookDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetLogbookDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ElectronicLogbook | View |
Customer must have one of these License values set| Key | Right |
|---|
| ElectronicLogbook |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Gets a list of LogbookEvents",
"operationId": "GetLogbookEvents",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"LogbookEvents"
],
"summary": "Creates a new logbookEvent record",
"operationId": "CreateLogbookEvent",
"requestBody": {
"description": "The LogbookEvent Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEvent_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/{eventNo}": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Gets a specific LogbookEvent",
"operationId": "GetLogbookEvent",
"parameters": [
{
"name": "eventNo",
"in": "path",
"description": "the eventNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested logbookEvent",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an logbookEvent with the supplied LogbookEvent No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"LogbookEvents"
],
"summary": "Updates an existing LogbookEvent",
"operationId": "UpdateLogbookEvent",
"parameters": [
{
"name": "eventNo",
"in": "path",
"description": "The eventNo of the logbookEvent to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The LogbookEvent DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated LogbookEvent object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEvent_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"LogbookEvents"
],
"summary": "Deletes an logbookEvent record",
"parameters": [
{
"name": "eventNo",
"in": "path",
"description": "The eventNo of the LogbookEvent to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEvent_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/{eventNo}/history": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Gets history for a specific LogbookEvent",
"operationId": "GetLogbookEventHistory",
"parameters": [
{
"name": "eventNo",
"in": "path",
"description": "The eventNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested logbookEvent",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an logbookEvent with the supplied LogbookEvent No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEvent_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/search": {
"post": {
"tags": [
"LogbookEvents"
],
"summary": "Search for logbookEvents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchLogbookEvents",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/searchCount": {
"post": {
"tags": [
"LogbookEvents"
],
"summary": "Returns number of hits in a search for LogbookEvents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountLogbookEvents",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/searchIndex/{eventGuid}": {
"post": {
"tags": [
"LogbookEvents"
],
"summary": "Get index of a record in a search for LogbookEvents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexLogbookEvents",
"parameters": [
{
"name": "eventGuid",
"in": "path",
"description": "The logbookEvent to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/searchInfo": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoLogbookEvents",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LogbookEvents/{eventNo}/copy": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Copies an existing logbookEvent to a new object",
"operationId": "CopyLogbookEvent",
"parameters": [
{
"name": "eventNo",
"in": "path",
"description": "The EventNo of the logbookEvent to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new LogbookEvent object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEvent"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LogbookEvent_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/propertyDefinitions": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Get a list of PropertyDefinitions",
"operationId": "GetEventPropertyDefinitions",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"LogbookEvents"
],
"summary": "Creates a new PropertyDefinition record",
"operationId": "CreateEventPropertyDefinition",
"requestBody": {
"description": "The PropertyDefinition DTO object to create",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/propertyDefinitions/{propertyDefinitionGuid}": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Gets a specific PropertyDefinition",
"operationId": "GetEventPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested PropertyDefinition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an GetPropertyDefinition with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"LogbookEvents"
],
"summary": "Updates an existing PropertyDefinition",
"operationId": "UpdateEventPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The PropertyDefinition DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PropertyDefinition object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"LogbookEvents"
],
"summary": "Deletes a PropertyDefinition record",
"operationId": "DeleteEventPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/propertyDefinitions/{propertyDefinitionGuid}/listValues": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Returns a list of values for a PropertyDefinition",
"operationId": "GetEventPropertyDefinitionListValues",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The PropertyDefinition Guid to fetch values for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "textFilter",
"in": "query",
"description": "(optional) text filter",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the values for the ListOfValuesTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/propertyDefinitions/{propertyDefinitionGuid}/force": {
"delete": {
"tags": [
"LogbookEvents"
],
"summary": "Force Deletes a PropertyDefinition record",
"operationId": "ForceDeleteEventPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/propertyDefinitions/{propertyName}/available": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Lookup if PropertyName of a PropertyDefinition is not already in use and therefore available to be used",
"operationId": "LogbookEventPropertyNameAvailable",
"parameters": [
{
"name": "propertyName",
"in": "path",
"description": "The propertyName to check",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns true is property name is available to be used",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/screenLayout": {
"post": {
"tags": [
"LogbookEvents"
],
"summary": "Bulk updates screenlayout and a list of Property Definitions. The endpoint handles whether or not to create or update each record in the requst.",
"operationId": "BulkUpdateEventScreenLayout",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/{eventNo}/jobTemplate": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Creates a Job (non-persisted) based on the Event with the provided Event No.",
"operationId": "CreateJobFromLogbookEvent",
"parameters": [
{
"name": "eventNo",
"in": "path",
"description": "Event No. of the Job Request to base the Job on",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LogbookEvents/{eventNo}/documents": {
"get": {
"tags": [
"LogbookEvents"
],
"summary": "Returns a list of Documents used on the LogbookEvent",
"operationId": "GetLogbookEventDocuments",
"parameters": [
{
"name": "eventNo",
"in": "path",
"description": "The LogbookEventno to fetch triggers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the triggers for the logbookEvent",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEventDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEventDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEventDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LubeOilTypes": {
"get": {
"tags": [
"LubeOilTypes"
],
"summary": "Gets a list of LubeOilTypes",
"operationId": "GetLubeOilTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"LubeOilTypes"
],
"summary": "Creates a new LubeOilType record",
"operationId": "CreateLubeOilType",
"requestBody": {
"description": "The LubeOilType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LubeOilType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LubeOilTypes/{lubeOilTypeNo}": {
"get": {
"tags": [
"LubeOilTypes"
],
"summary": "Gets a specific LubeOilType",
"operationId": "GetLubeOilType",
"parameters": [
{
"name": "lubeOilTypeNo",
"in": "path",
"description": "The LubeOilTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested LubeOilType",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an LubeOilType with the supplied LubeOilType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"LubeOilTypes"
],
"summary": "Updates an existing LubeOilType",
"operationId": "UpdateLubeOilType",
"parameters": [
{
"name": "lubeOilTypeNo",
"in": "path",
"description": "The LubeOilTypeNo of the LubeOilType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The LubeOilType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated LubeOilType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LubeOilType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"LubeOilTypes"
],
"summary": "Deletes a LubeOilType record",
"parameters": [
{
"name": "lubeOilTypeNo",
"in": "path",
"description": "The LubeOilTypeNo of the LubeOilType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LubeOilType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LubeOilTypes/{lubeOilTypeNo}/history": {
"get": {
"tags": [
"LubeOilTypes"
],
"summary": "Gets history for a specific LubeOilType",
"operationId": "GetLubeOilTypeHistory",
"parameters": [
{
"name": "lubeOilTypeNo",
"in": "path",
"description": "The LubeOilTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested LubeOilType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an LubeOilType with the supplied LubeOilType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LubeOilType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LubeOilTypes/search": {
"post": {
"tags": [
"LubeOilTypes"
],
"summary": "Search for LubeOilType\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchLubeOilTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested LubeOilType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LubeOilTypes/searchIndex/{lubeOilType}": {
"post": {
"tags": [
"LubeOilTypes"
],
"summary": "Get index of a record in a search for LubeOilTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexLubeOilType",
"parameters": [
{
"name": "lubeOilTypeGuid",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "lubeOilType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LubeOilTypes/searchCount": {
"post": {
"tags": [
"LubeOilTypes"
],
"summary": "Returns number of hits in a search for LubeOilTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountLubeOilTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/LubeOilTypes/searchInfo": {
"get": {
"tags": [
"LubeOilTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoLubeOilTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/LubeOilTypes/{lubeOilTypeNo}/copy": {
"get": {
"tags": [
"LubeOilTypes"
],
"summary": "Copies an existing LubeOilType to a new object",
"operationId": "CopyLubeOilType",
"parameters": [
{
"name": "lubeOilTypeNo",
"in": "path",
"description": "The LubeOilTypeNo of the LubeOilType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new LubeOilType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.LubeOilType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| LubeOilType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MailAccounts": {
"get": {
"tags": [
"MailAccounts"
],
"operationId": "GetMailAccounts",
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"MailAccounts"
],
"operationId": "CreateMailAccount",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MailAccount_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MailAccounts/{mailAccountNo}": {
"get": {
"tags": [
"MailAccounts"
],
"operationId": "GetMailAccount",
"parameters": [
{
"name": "mailAccountNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"MailAccounts"
],
"operationId": "UpdateMailAccount",
"parameters": [
{
"name": "mailAccountNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MailAccount_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"MailAccounts"
],
"parameters": [
{
"name": "mailAccountNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MailAccount_Delete | Delete |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MailAccounts/{mailAccountNo}/history": {
"get": {
"tags": [
"MailAccounts"
],
"operationId": "GetMailAccountHistory",
"parameters": [
{
"name": "mailAccountNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MailAccount_HistoryMode | HistoryMode |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MailAccounts/search": {
"post": {
"tags": [
"MailAccounts"
],
"operationId": "SearchMailAccounts",
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MailAccounts/searchIndex/{mailAccountGuid}": {
"post": {
"tags": [
"MailAccounts"
],
"operationId": "SearchIndexMailAccounts",
"parameters": [
{
"name": "mailAccountGuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MailAccounts/searchCount": {
"post": {
"tags": [
"MailAccounts"
],
"operationId": "SearchCountMailAccounts",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MailAccounts/searchInfo": {
"get": {
"tags": [
"MailAccounts"
],
"operationId": "SearchInfoMailAccounts",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/MailAccounts/{mailAccountNo}/copy": {
"get": {
"tags": [
"MailAccounts"
],
"operationId": "CopyMailAccount",
"parameters": [
{
"name": "mailAccountNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MailAccount_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MailAccounts/actions/test-smtp": {
"put": {
"tags": [
"MailAccounts"
],
"operationId": "TestMailAccountSmtpConnection",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MailAccount.MailAccount"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MailAccount_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments": {
"get": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Gets a list of ManagementSystemApprovedPlanDocuments",
"operationId": "GetManagementSystemApprovedPlanDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateManagementSystemApprovedPlanDocument",
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/{documentNo}": {
"get": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Gets a specific ManagementSystemApprovedPlanDocument",
"operationId": "GetManagementSystemApprovedPlanDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Updates an existing Document",
"operationId": "UpdateManagementSystemApprovedPlanDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| FormTemplates_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Get index of a record in a search for ManagementSystemApprovedPlanDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexManagementSystemApprovedPlanDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/{documentNo}/history": {
"get": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Gets history for a specific ManagementSystemApprovedPlanDocument",
"operationId": "GetManagementSystemApprovedPlanDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/search": {
"post": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchManagementSystemApprovedPlanDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/searchCount": {
"post": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountManagementSystemApprovedPlanDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/searchInfo": {
"get": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoManagementSystemApprovedPlanDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ManagementSystemApprovedPlanDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "",
"operationId": "GetManagementSystemApprovedPlanDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/{documentNo}/file": {
"get": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "",
"operationId": "GetManagementSystemApprovedPlanDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"operationId": "AddManagementSystemApprovedPlanDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetManagementSystemApprovedPlanDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetManagementSystemApprovedPlanDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/{documentNo}/checkout": {
"put": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutManagementSystemApprovedPlanDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/{documentNo}/checkin": {
"post": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "",
"operationId": "CheckinManagementSystemApprovedPlanDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/{documentNo}/copy": {
"get": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyManagementSystemApprovedPlanDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemApprovedPlanDocuments/{documentNo}/usage": {
"get": {
"tags": [
"ManagementSystemApprovedPlanDocuments"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetManagementSystemApprovedPlanDocumentsUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemBrowser": {
"get": {
"tags": [
"ManagementSystemBrowser"
],
"summary": "Gets a list of Management Systems the User has access to",
"operationId": "GetManagementSystems",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemBrowser/{managementSystemNo}": {
"get": {
"tags": [
"ManagementSystemBrowser"
],
"operationId": "GetManagementSystemUnits",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemBrowser/{managementSystemNo}/{unitNo}/Sections": {
"get": {
"tags": [
"ManagementSystemBrowser"
],
"operationId": "GetManagementSystemBrowserRootNodes",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemBrowser/{managementSystemNo}/{unitNo}/{sectionNo}/Children": {
"get": {
"tags": [
"ManagementSystemBrowser"
],
"operationId": "GetManagementSystemBrowserNodeChildren",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sectionNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemBrowser/{managementSystemNo}/{unitNo}/Section/{sectionNo}": {
"get": {
"tags": [
"ManagementSystemBrowser"
],
"summary": "Returns a management system browser tree structure from root to where the requested object is in the tree\r\nAll nodes along the way is populated.",
"operationId": "GetSectionInTree",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sectionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemBrowser/{managementSystemNo}/{unitNo}/Document/{documentNo}": {
"get": {
"tags": [
"ManagementSystemBrowser"
],
"summary": "Returns a management system browser tree structure from root to where the requested object is in the tree\r\nAll nodes along the way is populated.",
"operationId": "GetDocumentInTree",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemBrowser/{managementSystemNo}/{unitNo}/{documentNo}": {
"get": {
"tags": [
"ManagementSystemBrowser"
],
"summary": "Returns the specified Management System Document, based on the chosen Unit and Management System.",
"operationId": "GetManagementSystemBrowserDocument",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserDocument"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemBrowser/{managementSystemNo}/{unitNo}/{documentNo}/pdf": {
"get": {
"tags": [
"ManagementSystemBrowser"
],
"summary": "Returns the specified Management System Document's Preview File, based on the chosen Unit and Management System.",
"operationId": "GetManagementSystemBrowserDocumentFile",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "searchText",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserDocument"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemBrowser/{managementSystemNo}/{unitNo}/document/search": {
"get": {
"tags": [
"ManagementSystemBrowser"
],
"summary": "Returns the a collection of Management System Documents, based on the chosen Management System and the provided search text.",
"operationId": "FullTextSearchManagementSystemBrowserDocuments",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "searchText",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserDocument"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Gets a list of ManagementSystemChangeRequests",
"operationId": "GetManagementSystemChangeRequests",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Creates a new managementSystemChangeRequest record",
"operationId": "CreateManagementSystemChangeRequest",
"requestBody": {
"description": "The ManagementSystemChangeRequest Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Gets a specific ManagementSystemChangeRequest",
"operationId": "GetManagementSystemChangeRequest",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "the changeRequestNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystemChangeRequest",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystemChangeRequest with the supplied ManagementSystemChangeRequest No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Updates an existing ManagementSystemChangeRequest",
"operationId": "UpdateManagementSystemChangeRequest",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "The changeRequestNo of the managementSystemChangeRequest to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ManagementSystemChangeRequest DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ManagementSystemChangeRequest object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Deletes an managementSystemChangeRequest record",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "The changeRequestNo of the ManagementSystemChangeRequest to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/history": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Gets history for a specific ManagementSystemChangeRequest",
"operationId": "GetManagementSystemChangeRequestHistory",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "The changeRequestNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystemChangeRequest",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystemChangeRequest with the supplied ManagementSystemChangeRequest No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/search": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Search for managementSystemChangeRequests\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchManagementSystemChangeRequests",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/searchCount": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Returns number of hits in a search for ManagementSystemChangeRequests\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountManagementSystemChangeRequests",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/searchIndex/{managementSystemChangeRequestGuid}": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Get index of a record in a search for ManagementSystemChangeRequests\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexManagementSystemChangeRequests",
"parameters": [
{
"name": "managementSystemChangeRequestGuid",
"in": "path",
"description": "The managementSystemChangeRequest to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/searchInfo": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoManagementSystemChangeRequests",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/copy": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Copies an existing managementSystemChangeRequest to a new object",
"operationId": "CopyManagementSystemChangeRequest",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "The changeRequestNo of the managementSystemChangeRequest to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ManagementSystemChangeRequest object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/responses": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Gets a list of ChangeRequest responses",
"operationId": "GetManagementSystemChangeRequestResponses",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "The ChangeRequest no. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/responses/count": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Returns number of ManagementSystemChangeRequestResponses for ChangeRequestNo",
"operationId": "CountManagementSystemChangeRequestResponses",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "The ChangeRequestNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/addResponse": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Add response",
"operationId": "AddManagementSystemChangeRequestResponse",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "The ChangeRequestNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ManagementSystemChangeRequestResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/units": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Returns the units for a Change Request.",
"operationId": "GetChangeRequestUnits",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/affectedunits": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Returns the affected units for a Change Request.",
"operationId": "GetChangeRequestAffectedUnits",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/markAsMinorChange": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Marks ManagementSystemChangeRequest as minor change",
"operationId": "MarkManagementSystemChangeRequestAsMinorChange",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "The changeRequestNo of the managementSystemChangeRequest to be marked as minor change",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated ManagementSystemChangeRequest object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_AllowMarkUnmarkAsMinorChan | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/unmarkAsMinorChange": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Unmarks ManagementSystemChangeRequest as minor change",
"operationId": "UnmarkManagementSystemChangeRequestAsMinorChange",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "The changeRequestNo of the managementSystemChangeRequest to be unmarked as minor change",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated ManagementSystemChangeRequest object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_AllowMarkUnmarkAsMinorChan | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/changeRequestUpdateDocument": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"operationId": "ChangeRequestUpdateDocument",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/approvers": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Returns the approvers for a Change Request.",
"operationId": "GetChangeRequestApprovers",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestApprover"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestApprover"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestApprover"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/currentUserCanApprove": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Returns if current user is allowed to approve a change request",
"operationId": "CurrentUserCanApproveChangeRequest",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/requestApproval": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Request Approval for a change request",
"operationId": "ChangeRequestRequestApproval",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/approve": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Approves a Change Request",
"operationId": "ChangeRequestApprove",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/reject": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Rejects a Change Request approval request",
"operationId": "ChangeRequestReject",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/changetodraft": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Change a Change Request approval status to Draft",
"operationId": "ChangeRequestChangeToDraft",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/changetorequested": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Change a Change Request approval status to Requested",
"operationId": "ChangeRequestChangeToRequested",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/bypassapproval": {
"post": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Bypass approval on a Change a Change Request",
"operationId": "ChangeRequestBypassApproval",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/awaitingMyApproval": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Returns a list of change requests that is awaiting my approval\r\nThe mapper",
"operationId": "GetChangeRequestAwaitingMyApproval",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemChangeRequests/{changeRequestNo}/compare": {
"get": {
"tags": [
"ManagementSystemChangeRequests"
],
"summary": "Returns a pdf of the compared documents",
"operationId": "Compare",
"parameters": [
{
"name": "changeRequestNo",
"in": "path",
"description": "the changeRequestNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystemChangeRequest",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/System.IO.File"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/System.IO.File"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/System.IO.File"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystemChangeRequest with the supplied ManagementSystemChangeRequest No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ChangeRequest | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentAcknowledgements": {
"get": {
"tags": [
"ManagementSystemDocumentAcknowledgements"
],
"summary": "Gets a list of ManagementSystemDocumentAcknowledgements",
"operationId": "GetManagementSystemDocumentAcknowledgements",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentAcknowledgements/{acknowledgementGuid}": {
"get": {
"tags": [
"ManagementSystemDocumentAcknowledgements"
],
"summary": "Gets a specific ManagementSystemDocumentAcknowledgement",
"operationId": "GetManagementSystemDocumentAcknowledgement",
"parameters": [
{
"name": "acknowledgementGuid",
"in": "path",
"description": "The guid of the ManagementSystemDocumentAcknowledgement to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystemDocumentAcknowledgement",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystemDocumentAcknowledgement with the supplied ManagementSystemDocumentAcknowledgement No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ManagementSystemDocumentAcknowledgements"
],
"summary": "Updates an existing ManagementSystemDocumentAcknowledgement",
"operationId": "UpdateManagementSystemDocumentAcknowledgement",
"parameters": [
{
"name": "acknowledgementGuid",
"in": "path",
"description": "The ManagementSystemDocumentAcknowledgementNo of the managementSystemDocumentAcknowledgement to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The ManagementSystemDocumentAcknowledgement DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ManagementSystemDocumentAcknowledgement object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentAcknowledgements/search": {
"post": {
"tags": [
"ManagementSystemDocumentAcknowledgements"
],
"summary": "Search for ManagementSystemDocumentAcknowledgements\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchManagementSystemDocumentAcknowledgements",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentAcknowledgements/searchIndex/{acknowledgementGuid}": {
"post": {
"tags": [
"ManagementSystemDocumentAcknowledgements"
],
"summary": "Get index of a record in a search for jobgroup\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexManagementSystemDocumentAcknowledgements",
"parameters": [
{
"name": "acknowledgementGuid",
"in": "path",
"description": "The jobgroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentAcknowledgements/searchCount": {
"post": {
"tags": [
"ManagementSystemDocumentAcknowledgements"
],
"summary": "Returns number of hits in a search for ManagementSystemDocumentAcknowledgements\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountManagementSystemDocumentAcknowledgements",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentAcknowledgements/searchInfo": {
"get": {
"tags": [
"ManagementSystemDocumentAcknowledgements"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoManagementSystemDocumentAcknowledgements",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ManagementSystemDocumentDocuments": {
"get": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Gets a list of ManagementSystemDocumentDocuments",
"operationId": "GetManagementSystemDocumentDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateManagementSystemDocumentDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/{documentNo}": {
"get": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Gets a specific ManagementSystemDocumentDocument",
"operationId": "GetManagementSystemDocumentDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Updates an existing Document",
"operationId": "UpdateManagementSystemDocumentDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Get index of a record in a search for ManagementSystemDocumentDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexManagementSystemDocumentDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/{documentNo}/history": {
"get": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Gets history for a specific ManagementSystemDocumentDocument",
"operationId": "GetManagementSystemDocumentDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/search": {
"post": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchManagementSystemDocumentDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/searchCount": {
"post": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountManagementSystemDocumentDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/searchInfo": {
"get": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoManagementSystemDocumentDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ManagementSystemDocumentDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "",
"operationId": "GetManagementSystemDocumentDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/{documentNo}/file": {
"get": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "",
"operationId": "GetManagementSystemDocumentDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"operationId": "AddManagementSystemDocumentDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetManagementSystemDocumentDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetManagementSystemDocumentDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/{documentNo}/checkout": {
"put": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutManagementSystemDocumentDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/{documentNo}/checkin": {
"post": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"summary": "",
"operationId": "CheckinManagementSystemDocumentDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocumentDocuments/zipArchive": {
"post": {
"tags": [
"ManagementSystemDocumentDocuments"
],
"operationId": "ZipManagementSystemDocumentArchive",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "The name for the Zip file",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns a zip file of the searched forms"
},
"404": {
"description": ""
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments": {
"get": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Gets a list of ManagementSystemDocuments",
"operationId": "GetManagementSystemDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Creates a new managementSystemDocument record",
"operationId": "CreateManagementSystemDocument",
"requestBody": {
"description": "The ManagementSystemDocument Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/{ID}": {
"get": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Gets a specific ManagementSystemDocument",
"operationId": "GetManagementSystemDocument",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The ID to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystemDocument",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystemDocument with the supplied ManagementSystemDocument No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Updates an existing ManagementSystemDocument",
"operationId": "UpdateManagementSystemDocument",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The ID of the managementSystemDocument to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ManagementSystemDocument DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ManagementSystemDocument object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Deletes a managementSystemDocument record",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The ID of the ManagementSystemDocument to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/{ID}/history": {
"get": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Gets history for a specific ManagementSystemDocument",
"operationId": "GetManagementSystemDocumentHistory",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The ID to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystemDocument",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystemDocument with the supplied ManagementSystemDocument No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/search": {
"post": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Search for ManagementSystemDocuments\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchManagementSystemDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/searchCount": {
"post": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Returns number of hits in a search for ManagementSystemDocuments\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountManagementSystemDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/searchIndex/{managementSystemDocumentGuid}": {
"post": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Get index of a record in a search for ManagementSystemDocuments\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexManagementSystemDocuments",
"parameters": [
{
"name": "managementSystemDocumentGuid",
"in": "path",
"description": "The item to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/searchInfo": {
"get": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoManagementSystemDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ManagementSystemDocuments/{ID}/copy": {
"get": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Copies an existing managementSystemDocument to a new object",
"operationId": "CopyManagementSystemDocument",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The ID of the managementSystemDocument to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new managementSystemDocument object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/{id}/units": {
"get": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Gets the units from a specific ManagementSystemDocument.",
"operationId": "GetManagementSystemDocumentUnits",
"parameters": [
{
"name": "id",
"in": "path",
"description": "the ID to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystemDocument units",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystemDocument with the supplied ManagementSystemDocument No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/{id}/affectedunits": {
"get": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Gets the units from a specific ManagementSystemDocument where the Draft property is set to false.",
"operationId": "GetManagementSystemDocumentAffectedUnits",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/{ID}/approvers": {
"get": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Gets a specific ManagementSystemDocument",
"operationId": "GetManagementSystemDocumentApprovers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "the ID to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystemDocument approvers",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystemDocument with the supplied ManagementSystemDocument No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/{id}/revisionhistory": {
"get": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Gets the ManagementSystemDocument revision history",
"operationId": "GetManagementSystemDocumentRevisionHistory",
"parameters": [
{
"name": "id",
"in": "path",
"description": "the ID for the ManagementSystemDocument",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested revision history",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentRevision"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentRevision"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentRevision"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a managementSystemDocument with the supplied ManagementSystemDocument No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemDocuments/{id}/cancreatechangerequest": {
"get": {
"tags": [
"ManagementSystemDocuments"
],
"summary": "Returns if a change request can be created.",
"operationId": "CanCreateChangeRequest",
"parameters": [
{
"name": "id",
"in": "path",
"description": "the ID for the ManagementSystemDocument",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the evaluation of whether a change request can be created.",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "boolean"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "boolean"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "boolean"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a managementSystemDocument with the supplied ManagementSystemDocument Id cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemDocument | View |
| ManagementSystemBrowser | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/{managementSystemNo}/setup": {
"post": {
"tags": [
"ManagementSystemPublish"
],
"summary": "",
"operationId": "SetupManagementSystemPublish",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/{managementSystemNo}/publishunits": {
"get": {
"tags": [
"ManagementSystemPublish"
],
"summary": "",
"operationId": "GetPublishUnits",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.IPublishUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.IPublishUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.IPublishUnit"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/{managementSystemNo}/validatePublishUnits": {
"post": {
"tags": [
"ManagementSystemPublish"
],
"operationId": "ValidatePublishUnits",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/{managementSystemNo}/publishabledocuments": {
"post": {
"tags": [
"ManagementSystemPublish"
],
"operationId": "GetPublishableDocuments",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishableDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishableDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishableDocument"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/{managementSystemNo}/validatePublishDocuments": {
"post": {
"tags": [
"ManagementSystemPublish"
],
"operationId": "ValidatePublishDocuments",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/{managementSystemNo}/initiatepublishtask": {
"post": {
"tags": [
"ManagementSystemPublish"
],
"operationId": "InitatePublishTask",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/{managementSystemNo}/initiateindexdocumentstask": {
"post": {
"tags": [
"ManagementSystemPublish"
],
"operationId": "InitateIndexDocumentsTask",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/{managementSystemNo}/intiateunitdeletion": {
"post": {
"tags": [
"ManagementSystemPublish"
],
"operationId": "IntiateUnitDeletion",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ApiPublishResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/publishtask/{guid}": {
"get": {
"tags": [
"ManagementSystemPublish"
],
"operationId": "GetPublishTask",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemPublishTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemPublishTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemPublishTask"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/{managementSystemNo}/{taskNo}": {
"get": {
"tags": [
"ManagementSystemPublish"
],
"operationId": "GetPublishTaskByTaskNo",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "taskNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemPublishTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemPublishTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemPublishTask"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemPublish/{managementSystemNo}/unlock": {
"post": {
"tags": [
"ManagementSystemPublish"
],
"operationId": "UnlockManagementSystem",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemROCs": {
"get": {
"tags": [
"ManagementSystemROCs"
],
"summary": "Gets a list of ManagementSystemROCs",
"operationId": "GetManagementSystemROCs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemROC | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemROCs/{managementSystemRocNo}": {
"get": {
"tags": [
"ManagementSystemROCs"
],
"summary": "Gets a specific ManagementSystemROC",
"operationId": "GetManagementSystemROC",
"parameters": [
{
"name": "managementSystemROCno",
"in": "path",
"description": "The ManagementSystemROCno of the ManagementSystemROC",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested measurement",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a ManagementSystemROC with the supplied ManagementSystemROC No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemROC | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemROCs/search": {
"post": {
"tags": [
"ManagementSystemROCs"
],
"summary": "Search for ManagementSystemROCs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchManagementSystemROCs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemROC | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemROCs/searchCount": {
"post": {
"tags": [
"ManagementSystemROCs"
],
"summary": "Returns number of hits in a search for ManagementSystemROCs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountManagementSystemROCs",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemROC | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemROCs/{managementSystemROCno}/pdf": {
"get": {
"tags": [
"ManagementSystemROCs"
],
"summary": "Returns the specified Management System ROC's Preview File.",
"operationId": "GetManagementSystemROCDocumentsPreview",
"parameters": [
{
"name": "managementSystemROCno",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROC"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemROC | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemROCs/{managementSystemROCNo}/documents": {
"get": {
"tags": [
"ManagementSystemROCs"
],
"summary": "Returns a list of Documents belonging to the ManagementSystemROC",
"operationId": "GetManagementSystemROCDocuments",
"parameters": [
{
"name": "managementSystemROCNo",
"in": "path",
"description": "The ManagementSystemROCNo to fetch documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the dcouments for the ManagementSystemROC",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROCDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROCDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemROCDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemROC | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Gets a list of ManagementSystems",
"operationId": "GetManagementSystemsList",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystems"
],
"summary": "Creates a new managementSystem record",
"operationId": "CreateManagementSystem",
"requestBody": {
"description": "The ManagementSystem Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Gets a specific ManagementSystem",
"operationId": "GetManagementSystem",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "The ManagementSystemNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystem",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystem with the supplied ManagementSystem No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ManagementSystems"
],
"summary": "Updates an existing ManagementSystem",
"operationId": "UpdateManagementSystem",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "The ManagementSystemNo of the managementSystem to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ManagementSystem DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ManagementSystem object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ManagementSystems"
],
"summary": "Deletes a managementSystem record",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "The ManagementSystemNo of the ManagementSystem to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/history": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Gets history for a specific ManagementSystem",
"operationId": "GetManagementSystemHistory",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "The ManagementSystemNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystem",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystem with the supplied ManagementSystem No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/search": {
"post": {
"tags": [
"ManagementSystems"
],
"summary": "Search for ManagementSystems\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchManagementSystems",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/searchCount": {
"post": {
"tags": [
"ManagementSystems"
],
"summary": "Returns number of hits in a search for ManagementSystems\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountManagementSystems",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/searchIndex/{managementSystemGuid}": {
"post": {
"tags": [
"ManagementSystems"
],
"summary": "Get index of a record in a search for ManagementSystems\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexManagementSystems",
"parameters": [
{
"name": "managementSystemGuid",
"in": "path",
"description": "The item to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/searchInfo": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoManagementSystems",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ManagementSystems/{managementSystemNo}/copy": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Copies an existing managementSystem to a new object",
"operationId": "CopyManagementSystem",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "The managementSystemNo of the managementSystem to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new managementSystem object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/GetManagementSystemsByUnitNo/{unitNo}": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Gets managementSystems by unitNo",
"operationId": "GetManagementSystemsByUnitNo",
"parameters": [
{
"name": "unitNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the managementSystems",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/confidentialities": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Gets the Confidentialities for a specific Management System",
"operationId": "GetManagementSystemConfidentialities",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Confidentialities",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemConfidentiality"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemConfidentiality"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemConfidentiality"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Management System with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/changeRequestUsers": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Gets the ChangeRequestUsers for a specific Management System",
"operationId": "GetManagementSystemChangeRequestUsers",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested ChangeRequestUsers",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemChangeRequestUser"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemChangeRequestUser"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemChangeRequestUser"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Management System with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/units": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Returns the units associated with the management system.",
"operationId": "GetManagementSystemRelatedUnits",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/approvers": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Returns the approvers of the management system.",
"operationId": "GetManagementSystemApprovers",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/deletedUnits": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Returns the deleted units associated with the management system.",
"operationId": "GetManagementSystemDeletedUnits",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDeletedUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDeletedUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDeletedUnit"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/publishTasks": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "",
"operationId": "GetManagementSystemPublishTasks",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ManagementSystemManagementSystemPublishTaskView"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ManagementSystemManagementSystemPublishTaskView"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ManagementSystemManagementSystemPublishTaskView"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/acknowledgers": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Returns the acknowledgers of the management system.",
"operationId": "GetManagementSystemAcknowledgers",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/acknowledgers/{acknowledgerno}/sections": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Returns the acknowledgers of the management system.",
"operationId": "GetManagementSystemAcknowledgerSections",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "acknowledgerno",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/image": {
"get": {
"tags": [
"ManagementSystems"
],
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystems"
],
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ManagementSystems"
],
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_Update | Update |
"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/{managementSystemNo}/print/{unitNo}": {
"get": {
"tags": [
"ManagementSystems"
],
"summary": "Gets managementSystems by unitNo",
"operationId": "PrintManagementSystem",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the managementSystems",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/MakeAvailableForAI/{managementSystemNo}": {
"put": {
"tags": [
"ManagementSystems"
],
"summary": "Marks an existing ManagementSystem as available for AI",
"operationId": "MakeAvailableForAI",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "The ManagementSystemNo of the managementSystem to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated ManagementSystem object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_ChangeAvailableForAI | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystems/MakeUnavailableForAI/{managementSystemNo}": {
"put": {
"tags": [
"ManagementSystems"
],
"summary": "Marks an existing ManagementSystem as unavailable for AI",
"operationId": "MakeUnavailableForAI",
"parameters": [
{
"name": "managementSystemNo",
"in": "path",
"description": "The ManagementSystemNo of the managementSystem to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated ManagementSystem object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystem"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystem_ChangeAvailableForAI | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemSections": {
"get": {
"tags": [
"ManagementSystemSections"
],
"summary": "Gets a list of ManagementSystemSections",
"operationId": "GetManagementSystemSections",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystemSections"
],
"summary": "Creates a new managementSystemSection record",
"operationId": "CreateManagementSystemSection",
"requestBody": {
"description": "The ManagementSystemSection Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemSections/{ID}": {
"get": {
"tags": [
"ManagementSystemSections"
],
"summary": "Gets a specific ManagementSystemSection",
"operationId": "GetManagementSystemSection",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "the ID to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystemSection",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystemSection with the supplied ManagementSystemSection No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ManagementSystemSections"
],
"summary": "Updates an existing ManagementSystemSection",
"operationId": "UpdateManagementSystemSection",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The ID of the managementSystemSection to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ManagementSystemSection DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ManagementSystemSection object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ManagementSystemSections"
],
"summary": "Deletes an managementSystemSection record",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The ID of the ManagementSystemSection to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemSections/{ID}/history": {
"get": {
"tags": [
"ManagementSystemSections"
],
"summary": "Gets history for a specific ManagementSystemSection",
"operationId": "GetManagementSystemSectionHistory",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The ID to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested managementSystemSection",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an managementSystemSection with the supplied ManagementSystemSection No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemSections/search": {
"post": {
"tags": [
"ManagementSystemSections"
],
"summary": "Search for managementSystemSections\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchManagementSystemSections",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemSections/searchCount": {
"post": {
"tags": [
"ManagementSystemSections"
],
"summary": "Returns number of hits in a search for ManagementSystemSections\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountManagementSystemSections",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemSections/searchIndex/{managementSystemSectionGuid}": {
"post": {
"tags": [
"ManagementSystemSections"
],
"summary": "Get index of a record in a search for ManagementSystemSections\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexManagementSystemSections",
"parameters": [
{
"name": "managementSystemSectionGuid",
"in": "path",
"description": "The managementSystemSection to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemSections/searchInfo": {
"get": {
"tags": [
"ManagementSystemSections"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoManagementSystemSections",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ManagementSystemSections/{ID}/copy": {
"get": {
"tags": [
"ManagementSystemSections"
],
"summary": "Copies an existing managementSystemSection to a new object",
"operationId": "CopyManagementSystemSection",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The ID of the managementSystemSection to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ManagementSystemSection object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemSections/{id}/revisionhistory": {
"get": {
"tags": [
"ManagementSystemSections"
],
"summary": "Gets the ManagementSystemSection revision history",
"operationId": "GetRevisionHistory",
"parameters": [
{
"name": "id",
"in": "path",
"description": "the ID for the ManagementSystemSection",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested revision history",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSectionUnit.ManagementSystemSectionUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSectionUnit.ManagementSystemSectionUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSectionUnit.ManagementSystemSectionUnit"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a managementSystemSection with the supplied ManagementSystemSection No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemSections/{sectionId}/approvers": {
"get": {
"tags": [
"ManagementSystemSections"
],
"summary": "Returns a list of Approvers on the ManagementSystemSection",
"operationId": "GetManagementSystemSectionApprovers",
"parameters": [
{
"name": "sectionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSectionApprover"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSectionApprover"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSectionApprover"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments": {
"get": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Gets a list of ManagementSystemTemplateDocuments",
"operationId": "GetManagementSystemTemplateDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateManagementSystemTemplateDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/{documentNo}": {
"get": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Gets a specific ManagementSystemTemplateDocument",
"operationId": "GetManagementSystemTemplateDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Updates an existing Document",
"operationId": "UpdateManagementSystemTemplateDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Get index of a record in a search for ManagementSystemTemplateDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexManagementSystemTemplateDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/{documentNo}/history": {
"get": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Gets history for a specific ManagementSystemTemplateDocument",
"operationId": "GetManagementSystemTemplateDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/search": {
"post": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchManagementSystemTemplateDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/searchCount": {
"post": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountManagementSystemTemplateDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/searchInfo": {
"get": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoManagementSystemTemplateDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ManagementSystemTemplateDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "",
"operationId": "GetManagementSystemTemplateDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/{documentNo}/file": {
"get": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "",
"operationId": "GetManagementSystemTemplateDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"operationId": "AddManagementSystemTemplateDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetManagementSystemTemplateDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetManagementSystemTemplateDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/{documentNo}/checkout": {
"put": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutManagementSystemTemplateDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ManagementSystemTemplateDocuments/{documentNo}/checkin": {
"post": {
"tags": [
"ManagementSystemTemplateDocuments"
],
"summary": "",
"operationId": "CheckinManagementSystemTemplateDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ManagementSystemSection_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagement/updatedinstances": {
"get": {
"tags": [
"MasterDataManagement"
],
"operationId": "GetUpdatedInstances",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdatedPackageUnitInstance"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdatedPackageUnitInstance"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdatedPackageUnitInstance"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| MasterDataManagementWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagement/duplicatejobs": {
"post": {
"tags": [
"MasterDataManagement"
],
"operationId": "GetDuplicateJobs",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiDuplicateJob"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiDuplicateJob"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiDuplicateJob"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| MasterDataManagementWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagement/initiateupdateunitstask": {
"post": {
"tags": [
"MasterDataManagement"
],
"operationId": "InitiateUpdateUnitsTask",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| MasterDataManagementWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagement/initiatecopyunittask": {
"post": {
"tags": [
"MasterDataManagement"
],
"operationId": "InitiateCopyUnitTask",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiMDMCopyUnitArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiMDMCopyUnitArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiMDMCopyUnitArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiMDMCopyUnitArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| MasterDataManagementWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagementTasks/{taskNo}": {
"get": {
"tags": [
"MasterDataManagementTasks"
],
"summary": "Gets a specific MDM Task",
"operationId": "GetMasterDataManagementTask",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "The TaskNo of the MDMTask to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested MDMTask"
},
"400": {
"description": "Returns a validation result with information about the bad request"
},
"404": {
"description": "If a MDMTask with the supplied Task No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagementTasks/search": {
"post": {
"tags": [
"MasterDataManagementTasks"
],
"summary": "Search for MasterDataManagementTasks\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchMasterDataManagementTasks",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MasterDataManagementTask"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MasterDataManagementTask"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MasterDataManagementTask"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagementTasks/searchCount": {
"post": {
"tags": [
"MasterDataManagementTasks"
],
"summary": "Returns number of hits in a search for MasterDataManagementTasks\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountMasterDataManagementTasks",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagementTasks/searchIndex/{masterDataManagementTaskGuid}": {
"post": {
"tags": [
"MasterDataManagementTasks"
],
"summary": "Get index of a record in a search for MasterDataManagementTasks\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexMasterDataManagementTasks",
"parameters": [
{
"name": "masterDataManagementTaskGuid",
"in": "path",
"description": "The masterDataManagementTask to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagementTasks/searchInfo": {
"get": {
"tags": [
"MasterDataManagementTasks"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoMasterDataManagementTasks",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/MasterDataManagementTreeStructure": {
"get": {
"tags": [
"MasterDataManagementTreeStructure"
],
"operationId": "GetMDMRootNodes",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagementTreeStructure/{nodeType}/{visibleKey}/children": {
"get": {
"tags": [
"MasterDataManagementTreeStructure"
],
"operationId": "GetMDMChildren",
"parameters": [
{
"name": "nodeType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMNodeType"
}
},
{
"name": "visibleKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagementTreeStructure/{nodeType}/{visibleKey}": {
"get": {
"tags": [
"MasterDataManagementTreeStructure"
],
"summary": "Returns a tree structure from root to where the requested object is in the tree\r\nAll nodes along the way is populated.",
"operationId": "FindMDMNodeInTree",
"parameters": [
{
"name": "nodeType",
"in": "path",
"description": "",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMNodeType"
}
},
{
"name": "visibleKey",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagementTreeStructure/{componentNo}/componenttree": {
"get": {
"tags": [
"MasterDataManagementTreeStructure"
],
"summary": "Gets the full child component tree for the specified component no.",
"operationId": "GetAllComponentNodeChildren",
"parameters": [
{
"name": "componentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagementTreeStructure/{componentNo}/instances": {
"get": {
"tags": [
"MasterDataManagementTreeStructure"
],
"operationId": "GetUnitComponentInstances",
"parameters": [
{
"name": "componentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.MasterDataManagementModels.MDMComponentInstanceView"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.MasterDataManagementModels.MDMComponentInstanceView"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.MasterDataManagementModels.MDMComponentInstanceView"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterDataManagementUnitTreeStructure": {
"get": {
"tags": [
"MasterDataManagementUnitTreeStructure"
],
"operationId": "GetTreeStructure",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"MasterDataManagementUnitTreeStructure"
],
"operationId": "UpdateTreeStructure",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MasterDataManagement_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MasterUnit": {
"get": {
"tags": [
"MasterUnit"
],
"summary": "Gets the MasterUnit object",
"operationId": "GetMasterUnit",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MDMUnit": {
"get": {
"tags": [
"MDMUnit"
],
"summary": "Gets the MDM Unit object",
"operationId": "GetMDMUnit",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"MDMUnit"
],
"summary": "Change Unit No and/or Name of MDM Unit",
"operationId": "RenameMDMUnit",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Unit_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| MasterDataManagementWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementLocations": {
"get": {
"tags": [
"MeasurementLocations"
],
"summary": "Gets a list of MeasurementLocations",
"operationId": "GetMeasurementLocations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"MeasurementLocations"
],
"summary": "Creates a new measurementLocation record",
"operationId": "CreateMeasurementLocation",
"requestBody": {
"description": "The MeasurementLocation Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementLocations/{measurementLocationNo}": {
"get": {
"tags": [
"MeasurementLocations"
],
"summary": "Gets a specific MeasurementLocation",
"operationId": "GetMeasurementLocation",
"parameters": [
{
"name": "measurementLocationNo",
"in": "path",
"description": "The MeasurementLocationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested measurementLocation",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an measurementLocation with the supplied MeasurementLocation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"MeasurementLocations"
],
"summary": "Updates an existing MeasurementLocation",
"operationId": "UpdateMeasurementLocation",
"parameters": [
{
"name": "measurementLocationNo",
"in": "path",
"description": "The MeasurementLocationNo of the measurementLocation to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The MeasurementLocation DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated MeasurementLocation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"MeasurementLocations"
],
"summary": "Deletes a measurementLocation record",
"parameters": [
{
"name": "measurementLocationNo",
"in": "path",
"description": "The MeasurementLocationNo of the MeasurementLocation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementLocation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementLocations/{measurementLocationNo}/history": {
"get": {
"tags": [
"MeasurementLocations"
],
"summary": "Gets history for a specific MeasurementLocation",
"operationId": "GetMeasurementLocationHistory",
"parameters": [
{
"name": "measurementLocationNo",
"in": "path",
"description": "The MeasurementLocationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested measurementLocation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an measurementLocation with the supplied MeasurementLocation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementLocation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementLocations/search": {
"post": {
"tags": [
"MeasurementLocations"
],
"summary": "Search for MeasurementLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchMeasurementLocations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementLocations/searchIndex/{measurementLocationGuid}": {
"post": {
"tags": [
"MeasurementLocations"
],
"summary": "Get index of a record in a search for measurementtype\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexMeasurementLocations",
"parameters": [
{
"name": "measurementLocationGuid",
"in": "path",
"description": "The measurementtype to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementLocations/searchCount": {
"post": {
"tags": [
"MeasurementLocations"
],
"summary": "Returns number of hits in a search for MeasurementLocations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountMeasurementLocations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementLocations/searchInfo": {
"get": {
"tags": [
"MeasurementLocations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoMeasurementLocations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/MeasurementLocations/{measurementLocationNo}/copy": {
"get": {
"tags": [
"MeasurementLocations"
],
"summary": "Copies an existing measurementLocation to a new object",
"operationId": "CopyMeasurementLocation",
"parameters": [
{
"name": "measurementLocationNo",
"in": "path",
"description": "The MeasurementLocationNo of the MeasurementLocation to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new MeasurementLocation object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementLocation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements": {
"get": {
"tags": [
"Measurements"
],
"summary": "Gets a list of Measurements",
"operationId": "GetMeasurements",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Measurements"
],
"summary": "Creates a new measurement record",
"operationId": "CreateMeasurement",
"requestBody": {
"description": "The Measurement Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Measure_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/{measurementNo}": {
"get": {
"tags": [
"Measurements"
],
"summary": "Gets a specific Measurement",
"operationId": "GetMeasurement",
"parameters": [
{
"name": "measurementNo",
"in": "path",
"description": "The MeasurementNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested measurement",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an measurement with the supplied Measurement No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Measurements"
],
"summary": "Updates an existing Measurement",
"operationId": "UpdateMeasurement",
"parameters": [
{
"name": "measurementNo",
"in": "path",
"description": "The MeasurementNo of the measurement to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Measurement DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Measurement object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Measure_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Measurements"
],
"summary": "Deletes a measurement record",
"parameters": [
{
"name": "measurementNo",
"in": "path",
"description": "The MeasurementNo of the Measurement to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Measure_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/{measurementNo}/history": {
"get": {
"tags": [
"Measurements"
],
"summary": "Gets history for a specific Measurement",
"operationId": "GetMeasurementHistory",
"parameters": [
{
"name": "measurementNo",
"in": "path",
"description": "The MeasurementNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested measurement",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an measurement with the supplied Measurement No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Measure_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/search": {
"post": {
"tags": [
"Measurements"
],
"summary": "Search for Measurements\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchMeasurements",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/searchIndex/{measurementGuid}": {
"post": {
"tags": [
"Measurements"
],
"summary": "Get index of a record in a search for measurements\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexMeasurements",
"parameters": [
{
"name": "measurementGuid",
"in": "path",
"description": "The measurement to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/searchCount": {
"post": {
"tags": [
"Measurements"
],
"summary": "Returns number of hits in a search for Measurements\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountMeasurements",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/searchInfo": {
"get": {
"tags": [
"Measurements"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoMeasurements",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Measurements/{measurementNo}/readings": {
"get": {
"tags": [
"Measurements"
],
"summary": "Returns a the list of readings on the Measurement",
"operationId": "GetMeasurementHistories",
"parameters": [
{
"name": "measurementNo",
"in": "path",
"description": "The Measurement No to fetch measurement histories for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the measurement histories for the measurement",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementHistory"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementHistory"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementHistory"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Measurements"
],
"summary": "Performs a new Measurement History for the given measurement\r\nWill recalculate any related jobs",
"operationId": "AddMeasurementReading",
"parameters": [
{
"name": "measurementNo",
"in": "path",
"description": "The Measurement No to perform a reading for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The measurement history to add",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementHistory"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementHistory"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementHistory"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementHistory"
}
}
}
},
"responses": {
"200": {
"description": "The measurement reading is succesfully created"
},
"400": {
"description": "A validation result is returned with the reasons why the measurement reading was not accepted",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Measure_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/{measurementNo}/readings/graph/{daysToCover}": {
"get": {
"tags": [
"Measurements"
],
"summary": "Returns a list of Histories used on the Measurement prepared for graph",
"operationId": "GetMeasurementHistoriesForGraph",
"parameters": [
{
"name": "measurementNo",
"in": "path",
"description": "The Measurement No to fetch measurement histories for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "daysToCover",
"in": "path",
"description": "How many days the graph should cover",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Returns the measurement histories for the measurement",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementHistoryGraphData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementHistoryGraphData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementHistoryGraphData"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/{measurementNo}/copy": {
"get": {
"tags": [
"Measurements"
],
"summary": "Copies an existing Measurement to a new object",
"operationId": "CopyMeasurement",
"parameters": [
{
"name": "measurementNo",
"in": "path",
"description": "The MeasurementNo of the Measurement to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Measurement object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.Measurement"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Measure_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/appSubmit": {
"post": {
"tags": [
"Measurements"
],
"summary": "Receive new Measurement History from new Job App",
"operationId": "ReceiveMeasurementHistory",
"requestBody": {
"description": "The MeasurementHistory to Receive",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.MeasurementHistoryAppObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.MeasurementHistoryAppObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.MeasurementHistoryAppObject"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.MeasurementHistoryAppObject"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Measure_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/{measurementNo}/usage": {
"get": {
"tags": [
"Measurements"
],
"summary": "Gets usages for a specific Measurement",
"operationId": "GetMeasurementUsages",
"parameters": [
{
"name": "measurementNo",
"in": "path",
"description": "The MeasurementNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested measurement",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementUsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementUsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementUsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a measurement with the supplied Measurement No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/labels/{labelTemplateDocumentNo}": {
"post": {
"tags": [
"Measurements"
],
"summary": "Gets the labels to print",
"operationId": "PrintMeasurementLabels",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "the template No to print",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A Search Definition containing the component numbers to print",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested component report as pdf"
},
"404": {
"description": "If a component with the supplied Component No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/labels/{labelTemplateDocumentNo}/{settingsKey}": {
"get": {
"tags": [
"Measurements"
],
"summary": "Get the labels to print using ´settings key",
"operationId": "GetMeasurementsLabelPdf",
"parameters": [
{
"name": "labelTemplateDocumentNo",
"in": "path",
"description": "The template No to print",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "settingsKey",
"in": "path",
"description": "The UUID for the stored search definition",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Measurements/{measurementNo}/trend/{fromDate}": {
"get": {
"tags": [
"Measurements"
],
"summary": "Gets the trend of a Job's Measurement",
"operationId": "GetMeasurementTrend",
"parameters": [
{
"name": "measurementNo",
"in": "path",
"description": "The MeasurementNo",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fromDate",
"in": "path",
"description": "The start date from which the trend should be computed",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Returns the requested measurement",
"content": {
"text/plain": {
"schema": {
"type": "number",
"format": "double"
}
},
"application/json": {
"schema": {
"type": "number",
"format": "double"
}
},
"text/json": {
"schema": {
"type": "number",
"format": "double"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request"
},
"404": {
"description": "If an measurement with the supplied Measurement No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementTypes": {
"get": {
"tags": [
"MeasurementTypes"
],
"summary": "Gets a list of MeasurementTypes",
"operationId": "GetMeasurementTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"MeasurementTypes"
],
"summary": "Creates a new measurementType record",
"operationId": "CreateMeasurementType",
"requestBody": {
"description": "The MeasurementType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementTypes/{measurementTypeNo}": {
"get": {
"tags": [
"MeasurementTypes"
],
"summary": "Gets a specific MeasurementType",
"operationId": "GetMeasurementType",
"parameters": [
{
"name": "measurementTypeNo",
"in": "path",
"description": "The MeasurementTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested measurementType",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an measurementType with the supplied MeasurementType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"MeasurementTypes"
],
"summary": "Updates an existing MeasurementType",
"operationId": "UpdateMeasurementType",
"parameters": [
{
"name": "measurementTypeNo",
"in": "path",
"description": "The MeasurementTypeNo of the measurementType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The MeasurementType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated MeasurementType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"MeasurementTypes"
],
"summary": "Deletes a measurementType record",
"parameters": [
{
"name": "measurementTypeNo",
"in": "path",
"description": "The MeasurementTypeNo of the MeasurementType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementTypes/{measurementTypeNo}/history": {
"get": {
"tags": [
"MeasurementTypes"
],
"summary": "Gets history for a specific MeasurementType",
"operationId": "GetMeasurementTypeHistory",
"parameters": [
{
"name": "measurementTypeNo",
"in": "path",
"description": "The MeasurementTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested measurementType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an measurementType with the supplied MeasurementType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementTypes/search": {
"post": {
"tags": [
"MeasurementTypes"
],
"summary": "Search for MeasurementTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchMeasurementTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementTypes/searchIndex/{measurementTypeGuid}": {
"post": {
"tags": [
"MeasurementTypes"
],
"summary": "Get index of a record in a search for measurementtype\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexMeasurementTypes",
"parameters": [
{
"name": "measurementTypeGuid",
"in": "path",
"description": "The measurementtype to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementTypes/searchCount": {
"post": {
"tags": [
"MeasurementTypes"
],
"summary": "Returns number of hits in a search for MeasurementTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountMeasurementTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasurementTypes/searchInfo": {
"get": {
"tags": [
"MeasurementTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoMeasurementTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/MeasurementTypes/{measurementTypeNo}/copy": {
"get": {
"tags": [
"MeasurementTypes"
],
"summary": "Copies an existing measurementType to a new object",
"operationId": "CopyMeasurementType",
"parameters": [
{
"name": "measurementTypeNo",
"in": "path",
"description": "The MeasurementTypeNo of the MeasurementType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new MeasurementType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasurementType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasuringUnits": {
"get": {
"tags": [
"MeasuringUnits"
],
"summary": "Gets a list of MeasuringUnits",
"operationId": "GetMeasuringUnits",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"MeasuringUnits"
],
"summary": "Creates a new measuringUnit record",
"operationId": "CreateMeasuringUnit",
"requestBody": {
"description": "The MeasuringUnit Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasureUnit_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasuringUnits/{measuringUnitNo}": {
"get": {
"tags": [
"MeasuringUnits"
],
"summary": "Gets a specific MeasuringUnit",
"operationId": "GetMeasuringUnit",
"parameters": [
{
"name": "measuringUnitNo",
"in": "path",
"description": "The MeasuringUnitNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested measuringUnit",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an measuringUnit with the supplied MeasuringUnit No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"MeasuringUnits"
],
"summary": "Updates an existing MeasuringUnit",
"operationId": "UpdateMeasuringUnit",
"parameters": [
{
"name": "measuringUnitNo",
"in": "path",
"description": "The MeasuringUnitNo of the measuringUnit to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The MeasuringUnit DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated MeasuringUnit object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasureUnit_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"MeasuringUnits"
],
"summary": "Deletes a measuringUnit record",
"parameters": [
{
"name": "measuringUnitNo",
"in": "path",
"description": "The MeasuringUnitNo of the MeasuringUnit to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasureUnit_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasuringUnits/{measuringUnitNo}/history": {
"get": {
"tags": [
"MeasuringUnits"
],
"summary": "Gets history for a specific MeasuringUnit",
"operationId": "GetMeasuringUnitHistory",
"parameters": [
{
"name": "measuringUnitNo",
"in": "path",
"description": "The MeasuringUnitNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested measuringUnit",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an measuringUnit with the supplied MeasuringUnit No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasureUnit_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasuringUnits/search": {
"post": {
"tags": [
"MeasuringUnits"
],
"summary": "Search for MeasuringUnits\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchMeasuringUnits",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasuringUnits/searchCount": {
"post": {
"tags": [
"MeasuringUnits"
],
"summary": "Returns number of hits in a search for MeasuringUnits\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountMeasuringUnits",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasuringUnits/searchIndex/{measuringUnitGuid}": {
"post": {
"tags": [
"MeasuringUnits"
],
"summary": "Get index of a record in a search for MeasuringUnit\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexMeasuringUnits",
"parameters": [
{
"name": "measuringUnitGuid",
"in": "path",
"description": "The MeasuringUnit to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/MeasuringUnits/searchInfo": {
"get": {
"tags": [
"MeasuringUnits"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoMeasuringUnits",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/MeasuringUnits/{measuringUnitNo}/copy": {
"get": {
"tags": [
"MeasuringUnits"
],
"summary": "Copies an existing measuringUnit to a new object",
"operationId": "CopyMeasuringUnit",
"parameters": [
{
"name": "measuringUnitNo",
"in": "path",
"description": "The measuringUnitNo of the measuringUnit to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new measuringUnit object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MeasuringUnit.MeasuringUnit"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| MeasureUnit_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations": {
"get": {
"tags": [
"OdsrbOperations"
],
"summary": "Gets a list of OdsrbOperations",
"operationId": "GetOdsrbOperations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"OdsrbOperations"
],
"summary": "Creates a new OdsrbOperation",
"operationId": "CreateOdsrbOperation",
"requestBody": {
"description": "The OdsrbOperation wrapper Object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationCreate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationCreate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationCreate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationCreate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/{operationNo}": {
"get": {
"tags": [
"OdsrbOperations"
],
"summary": "Gets a specific OdsrbOperation",
"operationId": "GetOdsrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested OdsrbOperation",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an OdsrbOperation with the supplied OdsrbOperation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"OdsrbOperations"
],
"summary": "Updates an existing OdsrbOperation",
"operationId": "UpdateOdsrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the OdsrbOperation to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The OdsrbOperation DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated OdsrbOperation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"OdsrbOperations"
],
"summary": "Deletes a OdsrbOperation record",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the OdsrbOperation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/{operationNo}/history": {
"get": {
"tags": [
"OdsrbOperations"
],
"summary": "Gets history for a specific OdsrbOperation",
"operationId": "GetOdsrbOperationHistory",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested OdsrbOperation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an OdsrbOperation with the supplied OdsrbOperation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/search": {
"post": {
"tags": [
"OdsrbOperations"
],
"summary": "Search for OdsrbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchOdsrbOperations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested OdsrbOperation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/searchIndex/{OdsrbOperationGuid}": {
"post": {
"tags": [
"OdsrbOperations"
],
"summary": "Get index of a record in a search for OdsrbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexOdsrbOperations",
"parameters": [
{
"name": "OdsrbOperationGuid",
"in": "path",
"description": "The OdsrbOperation to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/searchCount": {
"post": {
"tags": [
"OdsrbOperations"
],
"summary": "Returns number of hits in a search for OdsrbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountOdsrbOperations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/searchInfo": {
"get": {
"tags": [
"OdsrbOperations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoOdsrbOperations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/OdsrbOperations/{operationNo}/copy": {
"get": {
"tags": [
"OdsrbOperations"
],
"summary": "Copies an existing OdsrbOperation to a new object",
"operationId": "CopyOdsrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the OdsrbOperation to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new OdsrbOperation object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/{operationNo}/Documents": {
"get": {
"tags": [
"OdsrbOperations"
],
"summary": "Returns a list of Documents on the OdsrbOperation",
"operationId": "GetOdsrbOperationDocumentLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbOperationDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbOperationDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbOperationDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/{operationNo}/Documents/{documentNo}": {
"get": {
"tags": [
"OdsrbOperations"
],
"summary": "Returns a specific Document on the Certificate",
"operationId": "GetOdsrbOperationDocumentLink",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbOperationDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbOperationDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbOperationDocument"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/GetPrintoutForOdsrbOperations": {
"post": {
"tags": [
"OdsrbOperations"
],
"operationId": "GetPrintoutForOdsrbOperations",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/GetLatestOdsrbOperationEndTime": {
"get": {
"tags": [
"OdsrbOperations"
],
"summary": "Get the latest operation end time",
"operationId": "GetLatestOdsrbOperationEndTime",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "date-time"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/{operationNo}/Signers": {
"get": {
"tags": [
"OdsrbOperations"
],
"summary": "Returns a list of Signers on the OdsrbOperation",
"operationId": "GetOdsrbOperationSignersLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationSigner"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationSigner"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationSigner"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/GetPrintoutTableDataForOdsrbOperations": {
"post": {
"tags": [
"OdsrbOperations"
],
"summary": "Gets a printout, based on a list of operationNo's",
"operationId": "GetPrintoutTableDataForOdsrbOperations",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/{operationNo}/OdsrbReceivers": {
"get": {
"tags": [
"OdsrbOperations"
],
"summary": "Returns a list of OdsrbReceivers on the OdsrbOperation",
"operationId": "GetOdsrbOperationOdsrbReceiverLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationOdsrbReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationOdsrbReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationOdsrbReceiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbOperations/sign": {
"post": {
"tags": [
"OdsrbOperations"
],
"summary": "Signs list of Operations",
"operationId": "SignOdsrbOperations",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated OdsrbOperation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbReceivers": {
"get": {
"tags": [
"OdsrbReceivers"
],
"summary": "Gets a list of Odsrb receivers",
"operationId": "GetOdsrbReceivers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"OdsrbReceivers"
],
"summary": "Creates a new OdsrbReceiver record",
"operationId": "CreateOdsrbReceiver",
"requestBody": {
"description": "The OdsrbReceiver Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbReceivers/{ReceiverNo}": {
"get": {
"tags": [
"OdsrbReceivers"
],
"summary": "Gets a specific OdsrbReceiver",
"operationId": "GetOdsrbReceiver",
"parameters": [
{
"name": "ReceiverNo",
"in": "path",
"description": "The ReceiverNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested OdsrbReceiver",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an OdsrbReceiver with the supplied OdsrbReceiver No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"OdsrbReceivers"
],
"summary": "Updates an existing OdsrbReceiver",
"operationId": "UpdateOdsrbReceiver",
"parameters": [
{
"name": "ReceiverNo",
"in": "path",
"description": "The ReceiverNo of the OdsrbReceiver to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The OdsrbReceiver DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated OdsrbReceiver object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbReceivers/{ReceiverNo}/history": {
"get": {
"tags": [
"OdsrbReceivers"
],
"summary": "Gets history for a specific OdsrbReceiver",
"operationId": "GetOdsrbReceiverHistory",
"parameters": [
{
"name": "ReceiverNo",
"in": "path",
"description": "The ReceiverNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested OdsrbReceiver",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an OdsrbReceiver with the supplied OdsrbReceiver No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbReceivers/search": {
"post": {
"tags": [
"OdsrbReceivers"
],
"summary": "Search for OdsrbReceivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchOdsrbReceivers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested OdsrbReceiver",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbReceivers/searchIndex/{OdsrbReceiverGuid}": {
"post": {
"tags": [
"OdsrbReceivers"
],
"summary": "Get index of a record in a search for OdsrbReceivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexOdsrbReceivers",
"parameters": [
{
"name": "OdsrbReceiverGuid",
"in": "path",
"description": "The OdsrbReceiver to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbReceivers/searchCount": {
"post": {
"tags": [
"OdsrbReceivers"
],
"summary": "Returns number of hits in a search for OdsrbReceivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountOdsrbReceivers",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbReceivers/searchInfo": {
"get": {
"tags": [
"OdsrbReceivers"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoOdsrbReceivers",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/OdsrbReceivers/{ReceiverNo}/copy": {
"get": {
"tags": [
"OdsrbReceivers"
],
"summary": "Copies an existing OdsrbReceiver to a new object",
"operationId": "CopyOdsrbReceiver",
"parameters": [
{
"name": "ReceiverNo",
"in": "path",
"description": "The ReceiverNo of the OdsrbReceiver to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new OdsrbReceiver object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbReceivers/{ReceiverNo}/Documents": {
"get": {
"tags": [
"OdsrbReceivers"
],
"summary": "Returns a list of Documents on the OdsrbReceiver",
"operationId": "GetOdsrbReceiverDocumentLinks",
"parameters": [
{
"name": "ReceiverNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbReceiverDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbReceiverDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbReceiverDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OdsrbReceivers/{ReceiverNo}/Documents/{documentNo}": {
"get": {
"tags": [
"OdsrbReceivers"
],
"summary": "Returns a specific Document on the OdsrbReceiver",
"operationId": "GetOdsrbReceiverDocumentLink",
"parameters": [
{
"name": "ReceiverNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbReceiverDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbReceiverDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbReceiverDocument"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OdsrbOperation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OperationTypeConfigurations": {
"get": {
"tags": [
"OperationTypeConfigurations"
],
"summary": "Gets a list of OperationTypeConfigurations",
"operationId": "GetOperationTypeConfigurations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OperationTypeConfigurations/{operationType}": {
"get": {
"tags": [
"OperationTypeConfigurations"
],
"summary": "Gets a specific OperationTypeConfiguration",
"operationId": "GetOperationTypeConfiguration",
"parameters": [
{
"name": "operationType",
"in": "path",
"description": "The operationType to get",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
}
}
],
"responses": {
"200": {
"description": "Returns the requested operationTypeConfiguration",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an operationTypeConfiguration with the supplied OperationTypeConfiguration No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OperationTypeConfigurations/Update": {
"post": {
"tags": [
"OperationTypeConfigurations"
],
"summary": "Bulk Updates a list of OperationTypeConfiguration",
"operationId": "BulkUpdateOperationTypeConfiguration",
"requestBody": {
"description": "The list of OperationTypeConfigurations DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated OperationTypeConfiguration object",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration"
}
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OperationTypeConfigurations/{operationType}/tankOperationConfigurations": {
"get": {
"tags": [
"OperationTypeConfigurations"
],
"summary": "Gets a list of TankOperationConfigurations",
"operationId": "GetTankOperationConfigurationsForOperationTypeConfiguration",
"parameters": [
{
"name": "operationType",
"in": "path",
"description": "The Certificate No. to fetch values for",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OperationTypeConfigurations/{operationType}/signLevelConfigurations": {
"get": {
"tags": [
"OperationTypeConfigurations"
],
"summary": "Gets a list of SignLevelConfigurations",
"operationId": "GetOperationTypeConfigurationSignLevelConfigurationsForOperationTypeConfiguration",
"parameters": [
{
"name": "operationType",
"in": "path",
"description": "The OperationTypeConfiguration No. to fetch values for",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfigurationSignLevelConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfigurationSignLevelConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfigurationSignLevelConfiguration"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OperationTypeConfigurations/operationConfigurationTree": {
"post": {
"tags": [
"OperationTypeConfigurations"
],
"summary": "Gets a hierarchical list of Logbooks -> OperationTypeConfigurationGroups -> OperationTypeConfigurations",
"operationId": "GetOperationConfigurationTree",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationConfigurationTreeSearchDefintion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationConfigurationTreeSearchDefintion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationConfigurationTreeSearchDefintion"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationConfigurationTreeSearchDefintion"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.LogbookNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.LogbookNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.LogbookNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OperationTypeConfigurations/operationConfigurationTree/{logbook}": {
"post": {
"tags": [
"OperationTypeConfigurations"
],
"summary": "Gets a hierarchical list of Logbooks -> OperationTypeConfigurationGroups -> OperationTypeConfigurations",
"operationId": "GetOperationConfigurationTreeForLogbook",
"parameters": [
{
"name": "logbook",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationConfigurationTreeSearchDefintion"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationConfigurationTreeSearchDefintion"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationConfigurationTreeSearchDefintion"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationConfigurationTreeSearchDefintion"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.LogbookNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.LogbookNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.LogbookNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/labeltemplates": {
"get": {
"tags": [
"Options"
],
"summary": "Gets all the LabelOptionsDocumentLink objects",
"operationId": "GetAllLabelOptionsDocumentLinks",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsDocumentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsDocumentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsDocumentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/labeltemplates/{type}": {
"get": {
"tags": [
"Options"
],
"summary": "Gets the LabelOptionsDocumentLink objects for the specified type",
"operationId": "GetLabelOptionsDocumentLinks",
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of the option documents to get",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+LabelType"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsDocumentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsDocumentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsDocumentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options": {
"get": {
"tags": [
"Options"
],
"summary": "Gets the Options object",
"operationId": "GetOptions",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/{optionKey}": {
"get": {
"tags": [
"Options"
],
"operationId": "GetSingleOptionsValue",
"parameters": [
{
"name": "optionKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/{guid}": {
"put": {
"tags": [
"Options"
],
"summary": "Updates the options object",
"operationId": "UpdateOptions",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/reportLogo": {
"get": {
"tags": [
"Options"
],
"operationId": "GetReportLogo",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Options"
],
"summary": "Update options Report Logo with a new image",
"operationId": "UpdateReportLogo",
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/defaultreportLogo": {
"post": {
"tags": [
"Options"
],
"summary": "Resets the report logo to the standard INEXTIA logo",
"operationId": "SetDefaultReportLogo",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/shipdexresources": {
"get": {
"tags": [
"Options"
],
"summary": "Gets all the ShipdexResources objects",
"operationId": "GetAllShipdexResources",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsShipdexResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsShipdexResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsShipdexResource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/imagesettings": {
"get": {
"tags": [
"Options"
],
"summary": "Gets all the ImageSettings objects",
"operationId": "GetAllImageSettings",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsImageSetting"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsImageSetting"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsImageSetting"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/dynamicreporttemplates": {
"get": {
"tags": [
"Options"
],
"summary": "Gets all the DynamicReportOptionsDocumentLink objects",
"operationId": "GetAllDynamicReportOptionsDocumentLinks",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/dynamicreporttemplates/{type}": {
"get": {
"tags": [
"Options"
],
"summary": "Gets the DynamicReportOptionsDocumentLink objects for the specified type",
"operationId": "GetDynamicReportOptionsDocumentLinks",
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of the option documents to get",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+GenericReportType"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/purchaseyearonunits": {
"post": {
"tags": [
"Options"
],
"summary": "Changes purchase year options on all units for which the current user has access",
"operationId": "SetPurchaseYearOnUnits",
"parameters": [
{
"name": "year",
"in": "query",
"description": "Two digits (00-99)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Options/testPunchoutConnection": {
"post": {
"tags": [
"Options"
],
"summary": "Test connection for punchout options",
"operationId": "TestPunchoutConnectionIndustry",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.PunchoutConnectionInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.PunchoutConnectionInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.PunchoutConnectionInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.PunchoutConnectionInput"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| WebhooksIntegration |
| PunchoutIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates": {
"get": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Gets a list of OptionsDynamicReportTemplates",
"operationId": "GetOptionsDynamicReportTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Creates a new document record",
"operationId": "CreateOptionsDynamicReportTemplate",
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/{documentNo}": {
"get": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Gets a specific OptionsDynamicReportTemplate",
"operationId": "GetOptionsDynamicReportTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Updates an existing Document",
"operationId": "UpdateOptionsDynamicReportTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/searchIndex/{documentGuid}": {
"post": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Get index of a record in a search for OptionsDynamicReportTemplate\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexOptionsDynamicReportTemplates",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to find index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/{documentNo}/history": {
"get": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Gets history for a specific OptionsDynamicReportTemplate",
"operationId": "GetOptionsDynamicReportTemplateHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/search": {
"post": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchOptionsDynamicReportTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/searchCount": {
"post": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountOptionsDynamicReportTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/searchInfo": {
"get": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoOptionsDynamicReportTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/OptionsDynamicReportTemplates/{documentNo}/pdf": {
"get": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "",
"operationId": "GetOptionsDynamicReportTemplatePdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/{documentNo}/file": {
"get": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "",
"operationId": "GetOptionsDynamicReportTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"OptionsDynamicReportTemplates"
],
"operationId": "AddOptionsDynamicReportTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Get document pdf from guid",
"operationId": "GetOptionsDynamicReportTemplatePdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Get document file from guid",
"operationId": "GetOptionsDynamicReportTemplateFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/{documentNo}/checkout": {
"put": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutOptionsDynamicReportTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/{documentNo}/checkin": {
"post": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "",
"operationId": "CheckinOptionsDynamicReportTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/{documentNo}/copy": {
"get": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyOptionsDynamicReportTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsDynamicReportTemplates/{documentNo}/usage": {
"get": {
"tags": [
"OptionsDynamicReportTemplates"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetOptionsDynamicReportTemplatesUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsGlobals": {
"get": {
"tags": [
"OptionsGlobals"
],
"summary": "Gets the OptionsGlobals object",
"operationId": "GetOptionsGlobals",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsGlobal"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsGlobal"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsGlobal"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsGlobals/{guid}": {
"put": {
"tags": [
"OptionsGlobals"
],
"summary": "Updates the options office object",
"operationId": "UpdateOptionsGlobal",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsGlobal"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsGlobal"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsGlobal"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsGlobal"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GlobalOptions_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsGlobals/UpdateGlobalUnitOptions": {
"put": {
"tags": [
"OptionsGlobals"
],
"summary": "Update Global options on all units",
"operationId": "UpdateGlobalUnitOptions",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| GlobalOptions_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates": {
"get": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Gets a list of OptionsOfficeDynamicReportTemplates",
"operationId": "GetOptionsOfficeDynamicReportTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Creates a new document record",
"operationId": "CreateOptionsOfficeDynamicReportTemplate",
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/{documentNo}": {
"get": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Gets a specific OptionsOfficeDynamicReportTemplate",
"operationId": "GetOptionsOfficeDynamicReportTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Updates an existing Document",
"operationId": "UpdateOptionsOfficeDynamicReportTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/searchIndex/{documentGuid}": {
"post": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Get index of a record in a search for OptionsOfficeDynamicReportTemplate\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexOptionsOfficeDynamicReportTemplates",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to find index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/{documentNo}/history": {
"get": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Gets history for a specific OptionsOfficeDynamicReportTemplate",
"operationId": "GetOptionsOfficeDynamicReportTemplateHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/search": {
"post": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchOptionsOfficeDynamicReportTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/searchCount": {
"post": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountOptionsOfficeDynamicReportTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/searchInfo": {
"get": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoOptionsOfficeDynamicReportTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/OptionsOfficeDynamicReportTemplates/{documentNo}/pdf": {
"get": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "",
"operationId": "GetOptionsOfficeDynamicReportTemplatePdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/{documentNo}/file": {
"get": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "",
"operationId": "GetOptionsOfficeDynamicReportTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"operationId": "AddOptionsOfficeDynamicReportTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Get document pdf from guid",
"operationId": "GetOptionsOfficeDynamicReportTemplatePdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Get document file from guid",
"operationId": "GetOptionsOfficeDynamicReportTemplateFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/{documentNo}/checkout": {
"put": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutOptionsOfficeDynamicReportTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/{documentNo}/checkin": {
"post": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "",
"operationId": "CheckinOptionsOfficeDynamicReportTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/{documentNo}/copy": {
"get": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyOptionsOfficeDynamicReportTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeDynamicReportTemplates/{documentNo}/usage": {
"get": {
"tags": [
"OptionsOfficeDynamicReportTemplates"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetOptionsOfficeDynamicReportTemplatesUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates": {
"get": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Gets a list of OptionsOfficeLabelTemplates",
"operationId": "GetOptionsOfficeLabelTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Creates a new document record",
"operationId": "CreateOptionsOfficeLabelTemplate",
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/{documentNo}": {
"get": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Gets a specific OptionsOfficeLabelTemplate",
"operationId": "GetOptionsOfficeLabelTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Updates an existing Document",
"operationId": "UpdateOptionsOfficeLabelTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/searchIndex/{documentGuid}": {
"post": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Get index of a record in a search for OptionsOfficeLabelTemplate\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexOptionsOfficeLabelTemplates",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to find index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/{documentNo}/history": {
"get": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Gets history for a specific OptionsOfficeLabelTemplate",
"operationId": "GetOptionsOfficeLabelTemplateHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/search": {
"post": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchOptionsOfficeLabelTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/searchCount": {
"post": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountOptionsOfficeLabelTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/searchInfo": {
"get": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoOptionsOfficeLabelTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/OptionsOfficeLabelTemplates/{documentNo}/pdf": {
"get": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "",
"operationId": "GetOptionsOfficeLabelTemplatePdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/{documentNo}/file": {
"get": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "",
"operationId": "GetOptionsOfficeLabelTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"operationId": "AddOptionsOfficeLabelTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Get document pdf from guid",
"operationId": "GetOptionsOfficeLabelTemplatePdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Get document file from guid",
"operationId": "GetOptionsOfficeLabelTemplateFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/{documentNo}/checkout": {
"put": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutOptionsOfficeLabelTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/{documentNo}/checkin": {
"post": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "",
"operationId": "CheckinOptionsOfficeLabelTemplateFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/{documentNo}/copy": {
"get": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyOptionsOfficeLabelTemplate",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Document2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOfficeLabelTemplates/{documentNo}/usage": {
"get": {
"tags": [
"OptionsOfficeLabelTemplates"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetOptionsOfficeLabelTemplatesUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices": {
"get": {
"tags": [
"OptionsOffices"
],
"summary": "Gets the OptionsOffices object",
"operationId": "GetOptionsOffices",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOffice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOffice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOffice"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices/{guid}": {
"put": {
"tags": [
"OptionsOffices"
],
"summary": "Updates the options office object",
"operationId": "UpdateOptionsOffice",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOffice"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOffice"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOffice"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOffice"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.Options"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices/imagesettings": {
"get": {
"tags": [
"OptionsOffices"
],
"summary": "Gets all the ElectronicLogbookSettings objects",
"operationId": "GetAllOfficeImageSettings",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeImageSetting"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeImageSetting"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeImageSetting"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices/dynamicreporttemplates": {
"get": {
"tags": [
"OptionsOffices"
],
"summary": "Gets all the DynamicReportOptionsOfficeDocumentLink objects",
"operationId": "GetAllDynamicReportOptionsOfficeDocumentLinks",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices/dynamicreporttemplates/{type}": {
"get": {
"tags": [
"OptionsOffices"
],
"summary": "Gets the DynamicReportOptionsOfficeDocumentLink objects for the specified type",
"operationId": "GetDynamicReportOptionsOfficeDocumentLinks",
"parameters": [
{
"name": "type",
"in": "path",
"description": "The type of the option documents to get",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+GenericReportType"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsOfficeDocumentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsOfficeDocumentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsOfficeDocumentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices/electronicLogbookSettings": {
"get": {
"tags": [
"OptionsOffices"
],
"summary": "Gets all the LogbookSettings objects",
"operationId": "GetAllOfficeElectronicLogbookSettings",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeElectronicLogbookSetting"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeElectronicLogbookSetting"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeElectronicLogbookSetting"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices/evaluationThresholdSettings": {
"get": {
"tags": [
"OptionsOffices"
],
"summary": "Gets all the EvaluationThresholdSettings objects",
"operationId": "GetAllOfficeEvaluationThresholdSettings",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeEvaluationThresholdSetting"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeEvaluationThresholdSetting"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeEvaluationThresholdSetting"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices/testPunchoutConnection": {
"post": {
"tags": [
"OptionsOffices"
],
"summary": "Test connection for punchout options",
"operationId": "TestPunchoutConnection",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.PunchoutConnectionInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.PunchoutConnectionInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.PunchoutConnectionInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.PunchoutConnectionInput"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| WebhooksIntegration |
| PunchoutIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices/labeltemplates": {
"get": {
"tags": [
"OptionsOffices"
],
"summary": "Gets all the LabelOptionsOfficeDocumentLink objects",
"operationId": "GetAllLabelOptionsOfficeDocumentLinks",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsOfficeDocumentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsOfficeDocumentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsOfficeDocumentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices/labeltemplates/{labelType}": {
"get": {
"tags": [
"OptionsOffices"
],
"summary": "Gets the LabelOptionsOfficeDocumentLink objects for the specified type on office options",
"operationId": "GetLabelOptionsOfficeDocumentLinks",
"parameters": [
{
"name": "labelType",
"in": "path",
"description": "The type of the option documents to get",
"required": true,
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OfficeLabelType"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsOfficeDocumentLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsOfficeDocumentLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsOfficeDocumentLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OptionsOffices/test-ai-api-connection": {
"post": {
"tags": [
"OptionsOffices"
],
"operationId": "AITestConnection",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.AiConnectionInput"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.AiConnectionInput"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.AiConnectionInput"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.AiConnectionInput"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Options_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbNoons": {
"get": {
"tags": [
"OrbNoons"
],
"summary": "Gets a list of Noons",
"operationId": "GetNoons",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"OrbNoons"
],
"summary": "Creates a new Noon record",
"operationId": "CreateNoon",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbNoon_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbNoons/{noonNo}": {
"get": {
"tags": [
"OrbNoons"
],
"summary": "Gets a specific Noon",
"operationId": "GetNoon",
"parameters": [
{
"name": "noonNo",
"in": "path",
"description": "The noonNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested noon",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an noon with the supplied Noon No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"OrbNoons"
],
"summary": "Updates an existing Noon",
"operationId": "UpdateNoon",
"parameters": [
{
"name": "noonNo",
"in": "path",
"description": "The noonNo of the noon to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Noon object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbNoon_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbNoons/getByDate": {
"post": {
"tags": [
"OrbNoons"
],
"summary": "Gets a specific Noon by date",
"operationId": "GetNoonByDate",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"application/*+json": {
"schema": {
"type": "string",
"format": "date-time"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested noon",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an noon with the supplied Noon No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbNoons/{noonNo}/history": {
"get": {
"tags": [
"OrbNoons"
],
"summary": "Gets history for a specific Noon",
"operationId": "GetNoonHistory",
"parameters": [
{
"name": "noonNo",
"in": "path",
"description": "The noonNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested noon",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an noon with the supplied Noon No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbNoon_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbNoons/search": {
"post": {
"tags": [
"OrbNoons"
],
"summary": "Search for Noons\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchNoons",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested noon",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbNoons/searchIndex/{noonGuid}": {
"post": {
"tags": [
"OrbNoons"
],
"summary": "Get index of a record in a search for noons\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexNoons",
"parameters": [
{
"name": "orbNoonGuid",
"in": "query",
"description": "The noon to get index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "noonGuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbNoons/searchCount": {
"post": {
"tags": [
"OrbNoons"
],
"summary": "Returns number of hits in a search for Noons\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountNoons",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbNoons/searchInfo": {
"get": {
"tags": [
"OrbNoons"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoNoons",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/OrbNoons/{noonNo}/copy": {
"get": {
"tags": [
"OrbNoons"
],
"summary": "Copies an existing Noon to a new object",
"operationId": "CopyNoon",
"parameters": [
{
"name": "noonNo",
"in": "path",
"description": "The noonNo of the noon to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Noon object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoon"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbNoon_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbNoons/{noonNo}/FuelConsumption": {
"get": {
"tags": [
"OrbNoons"
],
"summary": "Returns a list of FuelConsumption on the Noon",
"operationId": "GetFuelConsumption",
"parameters": [
{
"name": "noonNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoonFuelType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoonFuelType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoonFuelType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbNoons/{noonNo}/Desludgings": {
"get": {
"tags": [
"OrbNoons"
],
"summary": "Returns a list of Desludgings on the Noon",
"operationId": "GetDesludgings",
"parameters": [
{
"name": "noonNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoonPurifier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoonPurifier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoonPurifier"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Gets a list of OrbOperations",
"operationId": "GetOrbOperations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"OrbOperations"
],
"summary": "Creates a new orbOperation record together with Soundings",
"operationId": "CreateOrbOperation",
"requestBody": {
"description": "The OrbOperation and Soudings wrapper Object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationCreate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationCreate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationCreate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationCreate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/{operationNo}": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Gets a specific OrbOperation",
"operationId": "GetOrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested orbOperation",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an orbOperation with the supplied OrbOperation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"OrbOperations"
],
"summary": "Updates an existing OrbOperation",
"operationId": "UpdateOrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the orbOperation to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The OrbOperation DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated OrbOperation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"OrbOperations"
],
"summary": "Deletes a orbOperation record",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the OrbOperation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/{operationNo}/history": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Gets history for a specific OrbOperation",
"operationId": "GetOrbOperationHistory",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested orbOperation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an orbOperation with the supplied OrbOperation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/search": {
"post": {
"tags": [
"OrbOperations"
],
"summary": "Search for OrbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchOrbOperations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested orbOperation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/searchIndex/{orbOperationGuid}": {
"post": {
"tags": [
"OrbOperations"
],
"summary": "Get index of a record in a search for orbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexOrbOperations",
"parameters": [
{
"name": "orbOperationGuid",
"in": "path",
"description": "The orbOperation to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/searchCount": {
"post": {
"tags": [
"OrbOperations"
],
"summary": "Returns number of hits in a search for OrbOperations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountOrbOperations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/searchInfo": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoOrbOperations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/OrbOperations/{operationNo}/copy": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Copies an existing OrbOperation to a new object",
"operationId": "CopyOrbOperation",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the orbOperation to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new OrbOperation object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/{operationNo}/force": {
"delete": {
"tags": [
"OrbOperations"
],
"summary": "Deletes a orbOperation record",
"parameters": [
{
"name": "operationNo",
"in": "path",
"description": "The operationNo of the OrbOperation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/{operationNo}/Documents": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Returns a list of Documents on the OrbOperation",
"operationId": "GetOrbOperationDocumentLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/{operationNo}/Soundings": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Returns a list of Soundings on the OrbOperation",
"operationId": "GetOrbOperationSoundingLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/{operationNo}/Receivers": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Returns a list of Receivers on the OrbOperation",
"operationId": "GetOrbOperationReceiverLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationReceiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationReceiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationReceiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/{operationNo}/SealSubSealPoints": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Returns a list of SeaslSubSealPoints on the OrbOperation",
"operationId": "GetOrbOperationSealSubSealPointLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationSealSubSealPoint"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationSealSubSealPoint"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationSealSubSealPoint"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/{operationNo}/Signers": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Returns a list of Signers on the OrbOperation",
"operationId": "GetOrbOperationSignersLinks",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationSigner"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationSigner"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationSigner"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/{operationNo}/Documents/{documentNo}": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Returns a specific Document on the Certificate",
"operationId": "GetOrbOperationDocumentLink",
"parameters": [
{
"name": "operationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/GetPrintoutForOperations": {
"post": {
"tags": [
"OrbOperations"
],
"summary": "Gets a printout, based on a list of operationNo's",
"operationId": "GetPrintoutForOperations",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/GetLatestOperationEndTime": {
"get": {
"tags": [
"OrbOperations"
],
"summary": "Get the latest operation end time",
"operationId": "GetLatestOperationEndTime",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "date-time"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/GetPrintoutTableDataForOperations": {
"post": {
"tags": [
"OrbOperations"
],
"summary": "Gets a printout, based on a list of operationNo's",
"operationId": "GetPrintoutTableDataForOperations",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/OrbOperations/sign": {
"post": {
"tags": [
"OrbOperations"
],
"summary": "Signs list of Operations",
"operationId": "SignOrbOperations",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationSignings"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated OrbOperation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PackingUnits": {
"get": {
"tags": [
"PackingUnits"
],
"summary": "Gets a list of PackingUnits",
"operationId": "GetPackingUnits",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"PackingUnits"
],
"summary": "Creates a new PackingUnit record",
"operationId": "CreatePackingUnit",
"requestBody": {
"description": "The PackingUnit Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PackingUnit_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PackingUnits/{packingUnitNo}": {
"get": {
"tags": [
"PackingUnits"
],
"summary": "Gets a specific PackingUnit",
"operationId": "GetPackingUnit",
"parameters": [
{
"name": "packingUnitNo",
"in": "path",
"description": "the PackingUnit No to get with",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested PackingUnit",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an PackingUnit with the supplied PackingUnit No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"PackingUnits"
],
"summary": "Updates an existing PackingUnit",
"operationId": "UpdatePackingUnit",
"parameters": [
{
"name": "packingUnitNo",
"in": "path",
"description": "The PackingUnit No of the PackingUnit to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The PackingUnit DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PackingUnit object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PackingUnit_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"PackingUnits"
],
"summary": "Deletes an PackingUnit record",
"parameters": [
{
"name": "packingUnitNo",
"in": "path",
"description": "The PackingUnit No of the PackingUnit to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PackingUnit_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PackingUnits/{packingUnitNo}/history": {
"get": {
"tags": [
"PackingUnits"
],
"summary": "Gets history for a specific PackingUnit",
"operationId": "GetPackingUnitHistory",
"parameters": [
{
"name": "packingUnitNo",
"in": "path",
"description": "The PackingUnit No to get with",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested PackingUnit history",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an PackingUnit with the supplied PackingUnit No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PackingUnit_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PackingUnits/searchInfo": {
"get": {
"tags": [
"PackingUnits"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPackingUnits",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/PackingUnits/search": {
"post": {
"tags": [
"PackingUnits"
],
"summary": "Search for PackingUnits\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPackingUnits",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PackingUnits/searchCount": {
"post": {
"tags": [
"PackingUnits"
],
"summary": "Returns number of hits in a search for PackingUnits\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPackingUnits",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PackingUnits/searchIndex/{packingUnitGuid}": {
"post": {
"tags": [
"PackingUnits"
],
"summary": "Get index of a record in a search for PackingUnits\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPackingUnits",
"parameters": [
{
"name": "packingUnitGuid",
"in": "path",
"description": "The PackingUnit to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PackingUnits/{packingUnitNo}/copy": {
"get": {
"tags": [
"PackingUnits"
],
"summary": "Copies an existing PackingUnit to a new object",
"operationId": "CopyPackingUnit",
"parameters": [
{
"name": "packingUnitNo",
"in": "path",
"description": "The PackingUnit No of the PackingUnit to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new PackingUnit object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.PackingUnit"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PackingUnit_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PaymentConditions": {
"get": {
"tags": [
"PaymentConditions"
],
"summary": "Gets a list of Payment Conditions",
"operationId": "GetPaymentConditions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PaymentCondition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"PaymentConditions"
],
"summary": "Creates a new paymentCondition record",
"operationId": "CreatePaymentCondition",
"requestBody": {
"description": "The paymentCondition Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PaymentCondition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PaymentConditions/{paymentConditionNo}": {
"get": {
"tags": [
"PaymentConditions"
],
"summary": "Gets a specific PaymentCondition",
"operationId": "GetPaymentCondition",
"parameters": [
{
"name": "paymentConditionNo",
"in": "path",
"description": "the paymentConditionNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested paymentCondition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an paymentCondition with the supplied PaymentCondition No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PaymentCondition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"PaymentConditions"
],
"summary": "Updates an existing paymentCondition",
"operationId": "UpdatePaymentCondition",
"parameters": [
{
"name": "paymentConditionNo",
"in": "path",
"description": "The paymentCondition of the paymentCondition to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The paymentCondition DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PaymentCondition object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PaymentCondition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"PaymentConditions"
],
"summary": "Deletes an paymentCondition record",
"parameters": [
{
"name": "paymentConditionNo",
"in": "path",
"description": "The paymentConditionNo of the paymentCondition to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PaymentCondition_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PaymentConditions/{paymentConditionNo}/history": {
"get": {
"tags": [
"PaymentConditions"
],
"summary": "Gets history for a specific PaymentCondition",
"operationId": "GetPaymentConditionHistory",
"parameters": [
{
"name": "paymentConditionNo",
"in": "path",
"description": "The paymentConditionNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested paymentCondition",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an paymentCondition with the supplied PaymentCondition No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PaymentCondition_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PaymentConditions/search": {
"post": {
"tags": [
"PaymentConditions"
],
"summary": "Search for paymentConditions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPaymentConditions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PaymentCondition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PaymentConditions/searchCount": {
"post": {
"tags": [
"PaymentConditions"
],
"summary": "Returns number of hits in a search for PaymentConditions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPaymentConditions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PaymentCondition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PaymentConditions/searchIndex/{paymentConditionGuid}": {
"post": {
"tags": [
"PaymentConditions"
],
"summary": "Get index of a record in a search for PaymentConditions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPaymentConditions",
"parameters": [
{
"name": "paymentConditionGuid",
"in": "path",
"description": "The paymentCondition to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PaymentCondition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PaymentConditions/searchInfo": {
"get": {
"tags": [
"PaymentConditions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPaymentConditions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/PaymentConditions/{paymentConditionNo}/copy": {
"get": {
"tags": [
"PaymentConditions"
],
"summary": "Copies an existing paymentCondition to a new object",
"operationId": "CopyPaymentCondition",
"parameters": [
{
"name": "paymentConditionNo",
"in": "path",
"description": "The PaymentConditionNo of the paymentCondition to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new PaymentCondition object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PaymentCondition.PaymentCondition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PaymentCondition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Ports": {
"get": {
"tags": [
"Ports"
],
"summary": "Gets a list of Ports",
"operationId": "GetPorts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Ports"
],
"summary": "Creates a new port record",
"operationId": "CreatePort",
"requestBody": {
"description": "The Port Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Port_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Ports/{portCodeNo}": {
"get": {
"tags": [
"Ports"
],
"summary": "Gets a specific Port",
"operationId": "GetPort",
"parameters": [
{
"name": "portCodeNo",
"in": "path",
"description": "the portCodeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested port",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an port with the supplied Port No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Ports"
],
"summary": "Updates an existing Port",
"operationId": "UpdatePort",
"parameters": [
{
"name": "portCodeNo",
"in": "path",
"description": "The portCodeNo of the port to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Port DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Port object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Port_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Ports"
],
"summary": "Deletes an port record",
"parameters": [
{
"name": "portCodeNo",
"in": "path",
"description": "The portCodeNo of the Port to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Port_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Ports/{portCodeNo}/history": {
"get": {
"tags": [
"Ports"
],
"summary": "Gets history for a specific Port",
"operationId": "GetPortHistory",
"parameters": [
{
"name": "portCodeNo",
"in": "path",
"description": "The portCodeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested port",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an port with the supplied Port No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Port_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Ports/search": {
"post": {
"tags": [
"Ports"
],
"summary": "Search for ports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPorts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Ports/searchCount": {
"post": {
"tags": [
"Ports"
],
"summary": "Returns number of hits in a search for Ports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPorts",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Ports/searchIndex/{portGuid}": {
"post": {
"tags": [
"Ports"
],
"summary": "Get index of a record in a search for Ports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPorts",
"parameters": [
{
"name": "portGuid",
"in": "path",
"description": "The port to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Ports/searchInfo": {
"get": {
"tags": [
"Ports"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPorts",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Ports/{portCodeNo}/copy": {
"get": {
"tags": [
"Ports"
],
"summary": "Copies an existing port to a new object",
"operationId": "CopyPort",
"parameters": [
{
"name": "portCodeNo",
"in": "path",
"description": "The PortCodeNo of the port to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Port object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Port"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Port_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods": {
"get": {
"tags": [
"PostingPeriods"
],
"summary": "Gets a list of PostingPeriods",
"operationId": "GetPostingPeriods",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"PostingPeriods"
],
"summary": "Creates a new PostingPeriod record",
"operationId": "CreatePostingPeriod",
"requestBody": {
"description": "The PostingPeriod Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods/{PostingPeriodNo}": {
"get": {
"tags": [
"PostingPeriods"
],
"summary": "Gets a specific PostingPeriod",
"operationId": "GetPostingPeriod",
"parameters": [
{
"name": "postingPeriodNo",
"in": "path",
"description": "the PostingPeriodNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested PostingPeriod",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a PostingPeriod with the supplied PostingPeriod No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods/{PostingPeriodNo}/history": {
"get": {
"tags": [
"PostingPeriods"
],
"summary": "Gets history for a specific PostindPeriod",
"operationId": "GetPostingPeriodHistory",
"parameters": [
{
"name": "postingPeriodNo",
"in": "path",
"description": "The PostingPeriodNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested PostingPeriod",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If aa PostingPeriod with the supplied PostingPeriod No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods/search": {
"post": {
"tags": [
"PostingPeriods"
],
"summary": "Search for PostingPeriods\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPostingPeriods",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods/searchCount": {
"post": {
"tags": [
"PostingPeriods"
],
"summary": "Returns number of hits in a search for PostingPeriod\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPostingPeriods",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods/searchIndex/{postingPeriodGUID}": {
"post": {
"tags": [
"PostingPeriods"
],
"summary": "Get index of a record in a search for PostingPeriod\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPostingPeriods",
"parameters": [
{
"name": "postingPeriodGUID",
"in": "path",
"description": "The PostingPeriod to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods/searchInfo": {
"get": {
"tags": [
"PostingPeriods"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPostingPeriods",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/PostingPeriods/{postingPeriodNo}": {
"put": {
"tags": [
"PostingPeriods"
],
"summary": "Updates an existing PostingPeriod",
"operationId": "UpdatePostingPeriod",
"parameters": [
{
"name": "postingPeriodNo",
"in": "path",
"description": "The PostingPeriodNo of the PostingPeriod to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The PostingPeriod DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PostingPeriod object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"PostingPeriods"
],
"summary": "Deletes an PostingPeriod record",
"parameters": [
{
"name": "postingPeriodNo",
"in": "path",
"description": "The PostingPeriodNo of the PostingPeriod to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods/{postingPeriodNo}/copy": {
"get": {
"tags": [
"PostingPeriods"
],
"summary": "Copies an existing PostingPeriod to a new object",
"operationId": "CopyPostingPeriod",
"parameters": [
{
"name": "postingPeriodNo",
"in": "path",
"description": "The PostingPeriodNo of the PostingPeriod to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new PostingPeriod object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriod"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods/{postingPeriodNo}/companies": {
"get": {
"tags": [
"PostingPeriods"
],
"summary": "Fetches all Companies attached to the posting period",
"operationId": "GetPostingPeriodCompanies",
"parameters": [
{
"name": "postingPeriodNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the posting period companies for the posting period",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodCompany"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodCompany"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodCompany"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods/{postingPeriodNo}/periods": {
"get": {
"tags": [
"PostingPeriods"
],
"summary": "Fetches all periods attached to the posting period",
"operationId": "GetPostingPeriodPeriods",
"parameters": [
{
"name": "postingPeriodNo",
"in": "path",
"description": "The PostingPeriodNo of the PostingPeriod",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the posting period periods for the posting period",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodPeriod"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodPeriod"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodPeriod"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostingPeriods/{invoiceNo}/openperiod": {
"get": {
"tags": [
"PostingPeriods"
],
"summary": "Get Open PostingPeriodPeriod for invoice",
"operationId": "GetOpenPostingPeriodPeriodsForInvoice",
"parameters": [
{
"name": "invoiceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodPeriod"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodPeriod"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodPeriod"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostingPeriod | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostponementReasons": {
"get": {
"tags": [
"PostponementReasons"
],
"summary": "Gets a list of PostponementReasons",
"operationId": "GetPostponementReasons",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"PostponementReasons"
],
"summary": "Creates a new postponementReason record",
"operationId": "CreatePostPonementReason",
"requestBody": {
"description": "The PostponementReason Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostponementReasons/{postponementReasonNo}": {
"get": {
"tags": [
"PostponementReasons"
],
"summary": "Gets a specific PostponementReason",
"operationId": "GetPostponementReason",
"parameters": [
{
"name": "postponementReasonNo",
"in": "path",
"description": "The PostponementReasonNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested postponementReason",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an postponementReason with the supplied PostponementReason No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"PostponementReasons"
],
"summary": "Updates an existing PostponementReason",
"operationId": "UpdatePostponementReason ",
"parameters": [
{
"name": "postponementReasonNo",
"in": "path",
"description": "The PostponementReasonNo of the postponementReason to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The PostponementReason DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PostponementReason object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"PostponementReasons"
],
"summary": "Deletes a postponementReason record",
"parameters": [
{
"name": "postponementReasonNo",
"in": "path",
"description": "The PostponementReasonNo of the PostponementReason to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostponementReasons/{postponementReasonNo}/history": {
"get": {
"tags": [
"PostponementReasons"
],
"summary": "Gets history for a specific PostponementReason",
"operationId": "GetPostponementReasonHistory",
"parameters": [
{
"name": "postponementReasonNo",
"in": "path",
"description": "The PostponementReasonNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested postponementReason",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an PostponementReason with the supplied PostponementReason No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostponementReasons/search": {
"post": {
"tags": [
"PostponementReasons"
],
"summary": "Search for PostponementReasons\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPostponementReason",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested postponementReason",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostponementReasons/searchCount": {
"post": {
"tags": [
"PostponementReasons"
],
"summary": "Returns number of hits in a search for PostponementReasons\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPostponementReasons",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostponementReasons/searchInfo": {
"get": {
"tags": [
"PostponementReasons"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPostponementReasons",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/PostponementReasons/searchIndex/{postponementReasonGuid}": {
"post": {
"tags": [
"PostponementReasons"
],
"summary": "Get index of a record in a search for Components\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPostponementReasons",
"parameters": [
{
"name": "postponementReasonGuid",
"in": "path",
"description": "The postponementReason to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostponementReasons/{postponementReasonNo}/copy": {
"get": {
"tags": [
"PostponementReasons"
],
"summary": "Copies an existing PostponementReason to a new object",
"operationId": "CopyPostponementReason ",
"parameters": [
{
"name": "postponementReasonNo",
"in": "path",
"description": "The PostponementReasonNo of the postponementReason to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new PostponementReason object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PostponementReason"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PostponementReasons/{postponementReasonNo}/force": {
"delete": {
"tags": [
"PostponementReasons"
],
"summary": "Force deletes a postponementReason record\r\nForce deleting records may cause existing records to contain invalid data, that needs adjustment before they can be saved",
"parameters": [
{
"name": "postponementReasonNo",
"in": "path",
"description": "The PostponementReasonNo of the Component to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PostponementReason_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Priorities": {
"get": {
"tags": [
"Priorities"
],
"summary": "Gets a list of Priorities",
"operationId": "GetPriorities",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Priorities"
],
"summary": "Creates a new priority record",
"operationId": "CreatePriority",
"requestBody": {
"description": "The Priority Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Priority_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Priorities/{priorityNo}": {
"get": {
"tags": [
"Priorities"
],
"summary": "Gets a specific Priority",
"operationId": "GetPriority",
"parameters": [
{
"name": "priorityNo",
"in": "path",
"description": "The PriorityNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested priority",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an priority with the supplied Priority No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Priorities"
],
"summary": "Updates an existing Priority",
"operationId": "UpdatePriority",
"parameters": [
{
"name": "priorityNo",
"in": "path",
"description": "The PriorityNo of the priority to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Priority DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Priority object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Priority_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Priorities"
],
"summary": "Deletes a priority record",
"parameters": [
{
"name": "priorityNo",
"in": "path",
"description": "The PriorityNo of the Priority to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Priority_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Priorities/{priorityNo}/history": {
"get": {
"tags": [
"Priorities"
],
"summary": "Gets history for a specific Priority",
"operationId": "GetPriorityHistory",
"parameters": [
{
"name": "priorityNo",
"in": "path",
"description": "The PriorityNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested priority",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an priority with the supplied Priority No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Priority_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Priorities/search": {
"post": {
"tags": [
"Priorities"
],
"summary": "Search for Priorities\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPriorities",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested priority",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Priorities/searchIndex/{priorityGuid}": {
"post": {
"tags": [
"Priorities"
],
"summary": "Get index of a record in a search for priorities\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPriorities",
"parameters": [
{
"name": "priorityGuid",
"in": "path",
"description": "The priority to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Priorities/searchCount": {
"post": {
"tags": [
"Priorities"
],
"summary": "Returns number of hits in a search for Priorities\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPriorities",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Priorities/searchInfo": {
"get": {
"tags": [
"Priorities"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPriorities",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Priorities/{priorityNo}/copy": {
"get": {
"tags": [
"Priorities"
],
"summary": "Copies an existing Priority to a new object",
"operationId": "CopyPriority",
"parameters": [
{
"name": "priorityNo",
"in": "path",
"description": "The PriorityNo of the priority to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Priority object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Priority.Priority"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Priority_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Procedures": {
"get": {
"tags": [
"Procedures"
],
"summary": "Gets a list of Procedures",
"operationId": "GetProcedures",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Procedures"
],
"summary": "Creates a new procedure record",
"operationId": "CreateProcedure",
"requestBody": {
"description": "The Procedure Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Procedure_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Procedures/{procedureNo}": {
"get": {
"tags": [
"Procedures"
],
"summary": "Gets a specific Procedure",
"operationId": "GetProcedure",
"parameters": [
{
"name": "procedureNo",
"in": "path",
"description": "The ProcedureNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested procedure",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an procedure with the supplied Procedure No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Procedures"
],
"summary": "Updates an existing Procedure",
"operationId": "UpdateProcedure",
"parameters": [
{
"name": "procedureNo",
"in": "path",
"description": "The ProcedureNo of the procedure to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Procedure DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Procedure object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Procedure_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Procedures"
],
"summary": "Deletes a procedure record",
"parameters": [
{
"name": "procedureNo",
"in": "path",
"description": "The ProcedureNo of the Procedure to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Procedure_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Procedures/{procedureNo}/history": {
"get": {
"tags": [
"Procedures"
],
"summary": "Gets history for a specific Procedure",
"operationId": "GetProcedureHistory",
"parameters": [
{
"name": "procedureNo",
"in": "path",
"description": "The ProcedureNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested procedure",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an procedure with the supplied Procedure No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Procedure_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Procedures/search": {
"post": {
"tags": [
"Procedures"
],
"summary": "Search for Procedures\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchProcedures",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Procedures/searchIndex/{procedureGuid}": {
"post": {
"tags": [
"Procedures"
],
"summary": "Get index of a record in a search for procedures\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexProcedures",
"parameters": [
{
"name": "procedureGuid",
"in": "path",
"description": "The procedure to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Procedures/searchCount": {
"post": {
"tags": [
"Procedures"
],
"summary": "Returns number of hits in a search for Procedures\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountProcedures",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Procedures/searchInfo": {
"get": {
"tags": [
"Procedures"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoProcedures",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Procedures/{procedureNo}/documents": {
"get": {
"tags": [
"Procedures"
],
"summary": "Returns a list of Documents used on the Procedure",
"operationId": "GetProcedureDocuments",
"parameters": [
{
"name": "procedureNo",
"in": "path",
"description": "The Procedureno to fetch triggers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the triggers for the procedure",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.ProcedureDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.ProcedureDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.ProcedureDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Procedure | View |
| MaintenancePlanning | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Procedures/{procedureNo}/copy": {
"get": {
"tags": [
"Procedures"
],
"summary": "Copies an existing Procedure to a new object",
"operationId": "CopyProcedure",
"parameters": [
{
"name": "procedureNo",
"in": "path",
"description": "The ProcedureNo of the procedure to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Procedure object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.Procedure"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Procedure_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Projects": {
"get": {
"tags": [
"Projects"
],
"summary": "Gets a list of Projects",
"operationId": "GetProjects",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Projects"
],
"summary": "Creates a new project record",
"operationId": "CreateProject",
"requestBody": {
"description": "The Project Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Project_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Projects/{projectNo}": {
"get": {
"tags": [
"Projects"
],
"summary": "Gets a specific Project",
"operationId": "GetProject",
"parameters": [
{
"name": "projectNo",
"in": "path",
"description": "the projectNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested project",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an project with the supplied Project No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Projects"
],
"summary": "Updates an existing Project",
"operationId": "UpdateProject",
"parameters": [
{
"name": "projectNo",
"in": "path",
"description": "The projectNo of the project to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Project DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Project object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Project_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Projects"
],
"summary": "Deletes an project record",
"parameters": [
{
"name": "projectNo",
"in": "path",
"description": "The projectNo of the Project to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Project_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Projects/{projectNo}/history": {
"get": {
"tags": [
"Projects"
],
"summary": "Gets history for a specific Project",
"operationId": "GetProjectHistory",
"parameters": [
{
"name": "projectNo",
"in": "path",
"description": "The projectNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested project",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an project with the supplied Project No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Project_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Projects/search": {
"post": {
"tags": [
"Projects"
],
"summary": "Search for projects\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchProjects",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Projects/searchCount": {
"post": {
"tags": [
"Projects"
],
"summary": "Returns number of hits in a search for Projects\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountProjects",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Projects/searchIndex/{projectGuid}": {
"post": {
"tags": [
"Projects"
],
"summary": "Get index of a record in a search for Projects\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexProjects",
"parameters": [
{
"name": "projectGuid",
"in": "path",
"description": "The project to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Projects/searchInfo": {
"get": {
"tags": [
"Projects"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoProjects",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Projects/{projectNo}/copy": {
"get": {
"tags": [
"Projects"
],
"summary": "Copies an existing project to a new object",
"operationId": "CopyProject",
"parameters": [
{
"name": "projectNo",
"in": "path",
"description": "The ProjectNo of the project to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Project object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.Project"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Project_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Projects/{projectNo}/units": {
"get": {
"tags": [
"Projects"
],
"summary": "Returns a list of ProjectUnits",
"operationId": "GetProjectUnits",
"parameters": [
{
"name": "projectNo",
"in": "path",
"description": "The ProjectNo to fetch Units for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the project",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.ProjectUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.ProjectUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.ProjectUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Projects/{projectNo}/stakeholders": {
"get": {
"tags": [
"Projects"
],
"summary": "Returns a list of ProjectStakeholders",
"operationId": "GetProjectStakeholders",
"parameters": [
{
"name": "projectNo",
"in": "path",
"description": "The ProjectNo to fetch Stakeholders for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the stakeholders for the project",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.ProjectStakeholder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.ProjectStakeholder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.ProjectStakeholder"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseGroups": {
"get": {
"tags": [
"PurchaseGroups"
],
"summary": "Gets a list of PurchaseGroups",
"operationId": "GetPurchaseGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"PurchaseGroups"
],
"summary": "Creates a new purchaseGroup record",
"operationId": "CreatePurchaseGroup",
"requestBody": {
"description": "The PurchaseGroup Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseGroups/{purchaseGroupNo}": {
"get": {
"tags": [
"PurchaseGroups"
],
"summary": "Gets a specific PurchaseGroup",
"operationId": "GetPurchaseGroup",
"parameters": [
{
"name": "purchaseGroupNo",
"in": "path",
"description": "the purchaseGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested purchaseGroup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an purchaseGroup with the supplied PurchaseGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"PurchaseGroups"
],
"summary": "Updates an existing PurchaseGroup",
"operationId": "UpdatePurchaseGroup",
"parameters": [
{
"name": "purchaseGroupNo",
"in": "path",
"description": "The purchaseGroupNo of the purchaseGroup to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The PurchaseGroup DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PurchaseGroup object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"PurchaseGroups"
],
"summary": "Deletes an purchaseGroup record",
"parameters": [
{
"name": "purchaseGroupNo",
"in": "path",
"description": "The purchaseGroupNo of the PurchaseGroup to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseGroup_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseGroups/{purchaseGroupNo}/history": {
"get": {
"tags": [
"PurchaseGroups"
],
"summary": "Gets history for a specific PurchaseGroup",
"operationId": "GetPurchaseGroupHistory",
"parameters": [
{
"name": "purchaseGroupNo",
"in": "path",
"description": "The purchaseGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested purchaseGroup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an purchaseGroup with the supplied PurchaseGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseGroup_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseGroups/search": {
"post": {
"tags": [
"PurchaseGroups"
],
"summary": "Search for purchaseGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPurchaseGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseGroups/searchCount": {
"post": {
"tags": [
"PurchaseGroups"
],
"summary": "Returns number of hits in a search for PurchaseGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPurchaseGroups",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseGroups/searchIndex/{purchaseGroupGuid}": {
"post": {
"tags": [
"PurchaseGroups"
],
"summary": "Get index of a record in a search for PurchaseGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPurchaseGroups",
"parameters": [
{
"name": "purchaseGroupGuid",
"in": "path",
"description": "The purchaseGroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseGroups/searchInfo": {
"get": {
"tags": [
"PurchaseGroups"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPurchaseGroups",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/PurchaseGroups/{purchaseGroupNo}/copy": {
"get": {
"tags": [
"PurchaseGroups"
],
"summary": "Copies an existing purchaseGroup to a new object",
"operationId": "CopyPurchaseGroup",
"parameters": [
{
"name": "purchaseGroupNo",
"in": "path",
"description": "The PurchaseGroupNo of the purchaseGroup to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new PurchaseGroup object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseGroup.PurchaseGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrderApprovals/search": {
"post": {
"tags": [
"PurchaseOrderApprovals"
],
"summary": "Search for Purchase Order Approvals\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPurchaseOrderApprovals",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderApproval"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderApproval"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderApproval"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrderApprovals/searchCount": {
"post": {
"tags": [
"PurchaseOrderApprovals"
],
"summary": "Returns number of hits in a search for PurchaseOrder Approvals\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPurchaseOrderApprovals",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrderApprovals/searchIndex/{purchaseOrderApprovalGuid}": {
"post": {
"tags": [
"PurchaseOrderApprovals"
],
"summary": "Get index of a record in a search for PurchaseOrder Approvals\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPurchaseOrderApprovals",
"parameters": [
{
"name": "purchaseOrderApprovalGuid",
"in": "path",
"description": "The purchase order approval to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrderApprovals/searchInfo": {
"get": {
"tags": [
"PurchaseOrderApprovals"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPurchaseOrderApprovals",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/PurchaseOrderDeliveryCosts/search": {
"post": {
"tags": [
"PurchaseOrderDeliveryCosts"
],
"summary": "Search for Purchase Order Delivery Costs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPurchaseOrderDeliveryCosts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrderDeliveryCosts/searchCount": {
"post": {
"tags": [
"PurchaseOrderDeliveryCosts"
],
"summary": "Returns number of hits in a search for PurchaseOrder Delivery Costs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPurchaseOrderDeliveryCosts",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrderDeliveryCosts/searchIndex/{purchaseOrderDeliveryCostGuid}": {
"post": {
"tags": [
"PurchaseOrderDeliveryCosts"
],
"summary": "Get index of a record in a search for PurchaseOrder Delivery Costs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPurchaseOrderDeliveryCosts",
"parameters": [
{
"name": "purchaseOrderDeliveryCostGuid",
"in": "path",
"description": "The requisition to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrderDeliveryCosts/searchInfo": {
"get": {
"tags": [
"PurchaseOrderDeliveryCosts"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPurchaseOrderDeliveryCosts",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/PurchaseOrderPositions/search": {
"post": {
"tags": [
"PurchaseOrderPositions"
],
"summary": "Search for requisition positions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPurchaseOrderPositions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrderPositions/searchCount": {
"post": {
"tags": [
"PurchaseOrderPositions"
],
"summary": "Returns number of hits in a search for PurchaseOrder Positions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPurchaseOrderPositions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrderPositions/searchIndex/{requisitionPositionGuid}": {
"post": {
"tags": [
"PurchaseOrderPositions"
],
"summary": "Get index of a record in a search for PurchaseOrder Positions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPurchaseOrderPositions",
"parameters": [
{
"name": "requisitionPositionGuid",
"in": "path",
"description": "The requisition to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrderPositions/searchInfo": {
"get": {
"tags": [
"PurchaseOrderPositions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPurchaseOrderPositions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/PurchaseOrders": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets a list of PurchaseOrders",
"operationId": "GetPurchaseOrders",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Creates a new purchaseOrder record",
"operationId": "CreatePurchaseOrder",
"requestBody": {
"description": "The PurchaseOrder Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets a specific PurchaseOrder",
"operationId": "GetPurchaseOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested purchaseOrder",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an purchaseOrder with the supplied PurchaseOrder No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"PurchaseOrders"
],
"summary": "Updates an existing PurchaseOrder",
"operationId": "UpdatePurchaseOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The purchaseOrderNo of the purchaseOrder to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The PurchaseOrder DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PurchaseOrder object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
| EnableApiEndpointsPurchaseOrder |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"PurchaseOrders"
],
"summary": "Deletes an purchaseOrder record",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The purchaseOrderNo of the PurchaseOrder to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Delete | Delete |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/search": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Search for PurchaseOrders\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPurchaseOrders",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/searchIndex/{purchaseOrderGuid}": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Get index of a record in a search for purchaseOrders\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPurchaseOrders",
"parameters": [
{
"name": "purchaseOrderGuid",
"in": "path",
"description": "The purchaseOrder to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/searchCount": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Returns number of hits in a search for PurchaseOrders\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPurchaseOrders",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/searchInfo": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPurchaseOrders",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/PurchaseOrders/{purchaseOrderNo}/positions": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets a list of PurchaseOrders positions",
"operationId": "GetPurchaseOrderPositions",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrder No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/receive": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Received positions on the PurchaseOrder with PurchaseOrderNo.\r\nReception contains information about each position to receive.\r\nEither total of rejected and received items, or a delta to let API summarize total.\r\nIf Items are rejected a RejectRemark can be supplied as well.\r\nOptionally a DeliveryPort can be supplied if used in SERTICA.\r\nReturns Positions updated by the reception",
"operationId": "ReceivePurchaseOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo to receive positions for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Reception object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderReception"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderReception"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderReception"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderReception"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
| PurchaseOrder_AllowReceiveInInextia | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/allowReceive": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "",
"operationId": "AllowReceivePurchaseOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo to receive positions for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
| PurchaseOrder_AllowReceiveInInextia | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/history": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets history for a specific Purchase Order",
"operationId": "GetPurchaseOrderHistory",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The purchaseOrderNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested purchaseOrder",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an purchase order with the supplied Purchase order No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/copy": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Copies an existing purchaseOrder to a new object",
"operationId": "CopyPurchaseOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo of the purchaseOrder to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new PurchaseOrder object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/positions/{positionNo}": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Returns a specific purchase order position",
"operationId": "GetPurchaseOrderPosition",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "positionNo",
"in": "path",
"description": "The positionNo to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the position for the Purchase Order",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
}
}
}
},
"404": {
"description": "If a Purchase Order position with the supplied PositionNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ApprovalWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/documents": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Returns a list of Documents used on the PurchaseOrder",
"operationId": "GetPurchaseOrderDocuments",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderno to fetch documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the documents for the purchaseOrder",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/responses": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets a list of Purchase Order Responses",
"operationId": "GetPurchaseOrderResponses",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrder No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/responses/count": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Returns number of PurchaseOrderResponses for purchaseOrderNo",
"operationId": "CountPurchaseOrderResponses",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/purchaseorders/{purchaseOrderNo}/responses": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Add response",
"operationId": "AddPurchaseOrderResponse",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The purchaseOrderNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The PurchaseOrderResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/purchaseorders/{purchaseOrderNo}/sendtoemail": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Send purchase order to supplier",
"operationId": "SendPurchaseOrderToEmail",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The purchaseOrderNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The PurchaseOrderMail DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/purchaseordermailattachments": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetAttachmentsForPurchaseOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderMailAttachmentView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderMailAttachmentView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderMailAttachmentView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/placeorder": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "",
"operationId": "PurchaseOrderPlaceOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Place Order arguments",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_AllowOrder | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/openForChanges": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Opens an already ordered PurchaseOrder to be able to make changes and subsequently reorder it.",
"operationId": "PurchaseOrderOpenForChanges",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_AllowOpenForChanges | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
| EnableApiEndpointsPurchaseOrder |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/approveChanges": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Approves changes to PurchaseOrder and re-orders the PurchaseOrder again",
"operationId": "PurchaseOrderApproveChanges",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Place Order arguments",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_AllowOrder | Function |
| PurchaseOrder_AllowOpenForChanges | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
| EnableApiEndpointsPurchaseOrder |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/deliverycosts": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets a list of Purchas Order delivery costs",
"operationId": "GetPurchaseOrderDeliveryCosts",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrder No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/requestForQuotes": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Returns a list of Request For Quotes used on the Purchase Order",
"operationId": "GetPurchaseOrderRequestForQuotes",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The RequestForQuoteno to fetch documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the documents for the requestForQuote",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePurchaseOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePurchaseOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePurchaseOrder"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/requisitions": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Returns a list of Requisitions used on the Purchase Order",
"operationId": "GetPurchaseOrderRequisitions",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The RequestForQuoteno to fetch documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the documents for the requestForQuote",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderRequisition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderRequisition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderRequisition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/approvals": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets a list of Purchas Order approvals",
"operationId": "GetPurchaseOrderApprovals",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrder No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderApproval"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderApproval"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderApproval"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/cancelorder": {
"post": {
"tags": [
"PurchaseOrders"
],
"operationId": "PurchaseOrderCancelOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_AllowCancel | Function |
| PurchaseOrder_AllowCancelServiceOrder | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/reports": {
"get": {
"tags": [
"PurchaseOrders"
],
"operationId": "GetPurchaseOrderReportsFromUserSettings",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "override dynamic report",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested purchase order report as pdf"
},
"404": {
"description": "If a purchaseOrder with the supplied purchase order No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ApprovalWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{poNos}/reports": {
"get": {
"tags": [
"PurchaseOrders"
],
"operationId": "GetPurchaseOrderReports",
"parameters": [
{
"name": "poNos",
"in": "path",
"description": "A comma separated list of purchase order numbers to report",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "override dynamic report",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested purchase order report as pdf"
},
"404": {
"description": "If a purchaseOrder with the supplied purchase order No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ApprovalWeb |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/calculatedFields": {
"get": {
"tags": [
"PurchaseOrders"
],
"operationId": "GetPurchaseOrderCalculatedFields",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderCalculatedFields"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderCalculatedFields"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderCalculatedFields"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/positions/calculatedFields": {
"get": {
"tags": [
"PurchaseOrders"
],
"operationId": "GetPurchaseOrderPositionsCalculatedFields",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPositionCalculatedFields"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPositionCalculatedFields"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPositionCalculatedFields"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/positions/{positionNo}/calculatedFields": {
"get": {
"tags": [
"PurchaseOrders"
],
"operationId": "GetPurchaseOrderPositionCalculatedFields",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "positionNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPositionCalculatedFields"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPositionCalculatedFields"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPositionCalculatedFields"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/approveFromApprovalWeb": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Approve Purchase Order",
"operationId": "ApprovePurchaseOrderFromApprovalWeb",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo to approve",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/setupPlaceOrder": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Determine if a purchase order can be ordered",
"operationId": "PurchaseOrderSetupPlaceOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/allowCancelOrder": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Determine if a purchase order can be cancelled",
"operationId": "PurchaseOrderAllowCancelOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/setupApproveChanges": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Determine if the user can Approve Changes on the Purchase Order",
"operationId": "PurchaseOrderSetupApproveChanges",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/mail": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Get the Purchase Order Mail used as template for Send To Supplier",
"operationId": "PurchaseOrderMail",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderSendToSupplierArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderSendToSupplierArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderSendToSupplierArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderSendToSupplierArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/addremark": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Adds a Remark to the Purchase Order",
"operationId": "PurchaseOrdernAddRemark",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.PurchaseOrdersController+PurchaseOrderRemark"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.PurchaseOrdersController+PurchaseOrderRemark"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.PurchaseOrdersController+PurchaseOrderRemark"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.PurchaseOrdersController+PurchaseOrderRemark"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/getExistingForCombine": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Get list of existing PO's for adding applied REQ positions",
"operationId": "PurchaseOrderGetExistingForCombine",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderCombineArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderCombineArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderCombineArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderCombineArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/combineRequisitionPositions": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Combines requisition positions into a Purchase Order",
"operationId": "PurchaseOrderCombineRequisitionPositions",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderCombineArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderCombineArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderCombineArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderCombineArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiCombinePurchaseOrderResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiCombinePurchaseOrderResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiCombinePurchaseOrderResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/purchaseOrderUnits": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets a list of Purchase Order Units",
"operationId": "GetPurchaseOrderUnits",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrder No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/purchaseOrderSharedUnits": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets a list of Purchase Order Units",
"operationId": "GetPurchaseOrderSharedUnits",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrder No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/resendToSupplier": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "",
"operationId": "PurchaseOrderResendToSupplier",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Place Order arguments",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_AllowOrder | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/allowsendreminder": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Determine if a reminder can be sent for a purchase order",
"operationId": "AllowSendReminder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/sendreminder": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Send manual reminder to supplier for a purchase order",
"operationId": "SendReminder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_AllowOrder | Function |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/allowforwardforpriceapproval": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Determine if a purchase order can be forwarded for price approval",
"operationId": "AllowForwardForPriceApproval",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/forwardforpriceapproval": {
"post": {
"tags": [
"PurchaseOrders"
],
"operationId": "ForwardForPriceApproval",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPriceApprovalArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPriceApprovalArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPriceApprovalArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPriceApprovalArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/sendnotification": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Send a notification mail",
"operationId": "SendPurchaseOrderNotification",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The purchaseOrderNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The PurchaseOrderMail DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/allowpriceapproval": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Determine if a purchase order can be price approved",
"operationId": "AllowPriceApproval",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/priceapprove": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Price Approve a Purchase order",
"operationId": "PriceApprove",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPriceApprovalArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPriceApprovalArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPriceApprovalArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPriceApprovalArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/propertyDefinitions": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Get a list of PropertyDefinitions",
"operationId": "GetPurchaseOrderPropertyDefinitions",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Creates a new PropertyDefinition record",
"operationId": "CreatePurchaseOrderPropertyDefinition",
"requestBody": {
"description": "The PropertyDefinition DTO object to create",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/propertyDefinitions/{propertyDefinitionGuid}": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Gets a specific PropertyDefinition",
"operationId": "GetPurchaseOrderPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested PropertyDefinition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an GetPropertyDefinition with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"PurchaseOrders"
],
"summary": "Updates an existing PropertyDefinition",
"operationId": "UpdatePurchaseOrderPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The PropertyDefinition DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PropertyDefinition object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"PurchaseOrders"
],
"summary": "Deletes a PropertyDefinition record",
"operationId": "DeletePurchaseOrderPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/propertyDefinitions/{propertyDefinitionGuid}/listValues": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Returns a list of values for a PropertyDefinition",
"operationId": "GetPurchaseOrderPropertyDefinitionListValues",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The PropertyDefinition Guid to fetch values for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "textFilter",
"in": "query",
"description": "(optional) text filter",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the values for the ListOfValuesTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/propertyDefinitions/{propertyDefinitionGuid}/force": {
"delete": {
"tags": [
"PurchaseOrders"
],
"summary": "Force Deletes a PropertyDefinition record",
"operationId": "ForceDeletePurchaseOrderPropertyDefinition",
"parameters": [
{
"name": "propertyDefinitionGuid",
"in": "path",
"description": "The guid of the PropertyDefinition object",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/propertyDefinitions/{propertyName}/available": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Lookup if PropertyName of a PropertyDefinition is not already in use and therefore available to be used",
"operationId": "PurchaseOrderPropertyNameAvailable",
"parameters": [
{
"name": "propertyName",
"in": "path",
"description": "The propertyName to check",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns true is property name is available to be used",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/screenLayout": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Bulk updates screenlayout and a list of Property Definitions. The endpoint handles whether or not to create or update each record in the requst.",
"operationId": "BulkUpdatePurchaseOrderScreenLayout",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/createOrUpdateOrderedPurchaseOrder": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Creates a new purchase order record if it does not exist, or updates it if it does.\r\nThen an attempt to place order on the purchase order will be made.",
"operationId": "CreateOrUpdateOrderedPurchaseOrder",
"requestBody": {
"description": "The PurchaseOrder Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderGuid}/addDocuments": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Updates an existing finalized PurchaseOrder with documents",
"operationId": "PurchaseOrderAddDocuments",
"parameters": [
{
"name": "purchaseOrderGuid",
"in": "path",
"description": "The PurchaseOrder guid of the purchaseOrder to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The documents to add",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDocument"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDocument"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PurchaseOrder object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/resetApprovalSetup": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Resets approval setup on a purchaseOrder",
"operationId": "ResetApprovalSetup",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_ResetApprovalSetup | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/allowApproveChanges": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Check if the user is allowed to approve changes.",
"operationId": "AllowApproveChanges",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/standardTexts": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "",
"operationId": "GetPurchaseOrderStandardTexts",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderStandardText"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderStandardText"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderStandardText"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/punchout": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Execute PunchOut",
"operationId": "GetPunchOutPurchaseOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.PurchaseOrdersController+PurchaseOrderPunchOutAddress"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.PurchaseOrdersController+PurchaseOrderPunchOutAddress"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.PurchaseOrdersController+PurchaseOrderPunchOutAddress"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.PurchaseOrdersController+PurchaseOrderPunchOutAddress"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "uri"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "uri"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| PunchoutIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/getpunchoutpositions": {
"get": {
"tags": [
"PurchaseOrders"
],
"summary": "Get PunchOut Positions",
"operationId": "GetPurchaseOrderPunchOutPositions",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "uri"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "uri"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| PunchoutIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/returnpunchouttodraft": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Return PunchOut to Draft",
"operationId": "ReturnPurchaseOrderPuchOutToDraft",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "uri"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "uri"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| PunchoutIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/createCarrier": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Creates Carrier(s) for a Purchase Order, with CarrierPositions for each PO Position.\r\nIf the PO is shared, creates one Carrier per shared unit. Optionally sets TransitReceivedQuantity.",
"operationId": "CreateCarrierForPurchaseOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrderNo",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "setTransitReceivedQuantityToOrderedQuantity",
"in": "query",
"description": "If true, sets TransitReceivedQuantity to OrderedQuantity",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Carrier_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseOrders/{purchaseOrderNo}/setupCarrier/{carrierNo}": {
"post": {
"tags": [
"PurchaseOrders"
],
"summary": "Setup an existing Carrier for a Purchase Order, with CarrierPositions for each PO Position.\r\nIf the PO is shared, cannot proceed. Optionally sets TransitReceivedQuantity.",
"operationId": "SetupCarrierForPurchaseOrder",
"parameters": [
{
"name": "purchaseOrderNo",
"in": "path",
"description": "The PurchaseOrder No.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "carrierNo",
"in": "path",
"description": "The Carrier No. of the exisitng Carrier to setup",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "setTransitReceivedQuantityToOrderedQuantity",
"in": "query",
"description": "If true, sets TransitReceivedQuantity to OrderedQuantity",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Returns the setup Carrier",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Carrier"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a PurchaseOrder or a Carrier with the supplied PurchaseOrder No. or Carrier No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Carrier_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseTypes": {
"get": {
"tags": [
"PurchaseTypes"
],
"summary": "Gets a list of PurchaseTypes",
"operationId": "GetPurchaseTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"PurchaseTypes"
],
"summary": "Creates a new purchaseType record",
"operationId": "CreatePurchaseType",
"requestBody": {
"description": "The PurchaseType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Class_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseTypes/{purchaseTypeNo}": {
"get": {
"tags": [
"PurchaseTypes"
],
"summary": "Gets a specific PurchaseType",
"operationId": "GetPurchaseType",
"parameters": [
{
"name": "purchaseTypeNo",
"in": "path",
"description": "the purchaseTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested purchaseType",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an purchaseType with the supplied PurchaseType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"PurchaseTypes"
],
"summary": "Updates an existing PurchaseType",
"operationId": "UpdatePurchaseType",
"parameters": [
{
"name": "purchaseTypeNo",
"in": "path",
"description": "The purchaseTypeNo of the purchaseType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The PurchaseType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated PurchaseType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Class_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"PurchaseTypes"
],
"summary": "Deletes an purchaseType record",
"parameters": [
{
"name": "purchaseTypeNo",
"in": "path",
"description": "The purchaseTypeNo of the PurchaseType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Class_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseTypes/{purchaseTypeNo}/history": {
"get": {
"tags": [
"PurchaseTypes"
],
"summary": "Gets history for a specific PurchaseType",
"operationId": "GetPurchaseTypeHistory",
"parameters": [
{
"name": "purchaseTypeNo",
"in": "path",
"description": "The purchaseTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested purchaseType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an purchaseType with the supplied PurchaseType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Class_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseTypes/search": {
"post": {
"tags": [
"PurchaseTypes"
],
"summary": "Search for purchaseTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchPurchaseTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseTypes/searchCount": {
"post": {
"tags": [
"PurchaseTypes"
],
"summary": "Returns number of hits in a search for PurchaseTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountPurchaseTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseTypes/searchIndex/{purchaseTypeGuid}": {
"post": {
"tags": [
"PurchaseTypes"
],
"summary": "Get index of a record in a search for PurchaseTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexPurchaseTypes",
"parameters": [
{
"name": "purchaseTypeGuid",
"in": "path",
"description": "The purchaseType to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseTypes/searchInfo": {
"get": {
"tags": [
"PurchaseTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoPurchaseTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/PurchaseTypes/{purchaseTypeNo}/copy": {
"get": {
"tags": [
"PurchaseTypes"
],
"summary": "Copies an existing purchaseType to a new object",
"operationId": "CopyPurchaseType",
"parameters": [
{
"name": "purchaseTypeNo",
"in": "path",
"description": "The PurchaseTypeNo of the purchaseType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new PurchaseType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Class_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseTypes/{purchaseTypeNo}/unitfilters": {
"get": {
"tags": [
"PurchaseTypes"
],
"summary": "Fetches all Unit Filters attached to the Purchase Type",
"operationId": "GetPurchaseTypeUnitFilters",
"parameters": [
{
"name": "purchaseTypeNo",
"in": "path",
"description": "The purchaseTypeNo to fetch purchaseTypeUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the purchaseType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseTypeUnitFilter"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseTypeUnitFilter"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseTypeUnitFilter"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/PurchaseTypes/{purchaseTypeNo}/companyUnits": {
"get": {
"tags": [
"PurchaseTypes"
],
"summary": "Fetches all Company Units attached to the Purchase Type",
"operationId": "GetPurchaseTypeCompanyUnits",
"parameters": [
{
"name": "purchaseTypeNo",
"in": "path",
"description": "The purchaseTypeNo to fetch purchaseTypeUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the purchaseType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseTypeCompanyUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseTypeCompanyUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseTypeCompanyUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Purifiers": {
"get": {
"tags": [
"Purifiers"
],
"operationId": "GetPurifiers",
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Purifiers"
],
"operationId": "CreatePurifier",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Purifier_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Purifiers/{purifierNo}": {
"get": {
"tags": [
"Purifiers"
],
"operationId": "GetPurifier",
"parameters": [
{
"name": "purifierNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Purifiers"
],
"operationId": "UpdatePurifier",
"parameters": [
{
"name": "purifierNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Purifier_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Purifiers"
],
"parameters": [
{
"name": "purifierNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Purifier_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Purifiers/{purifierNo}/history": {
"get": {
"tags": [
"Purifiers"
],
"operationId": "GetPurifierHistory",
"parameters": [
{
"name": "purifierNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Purifier_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Purifiers/search": {
"post": {
"tags": [
"Purifiers"
],
"operationId": "SearchPurifiers",
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Purifiers/searchIndex/{purifierGuid}": {
"post": {
"tags": [
"Purifiers"
],
"operationId": "SearchIndexPurifierGuid",
"parameters": [
{
"name": "purifierGuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Purifiers/searchCount": {
"post": {
"tags": [
"Purifiers"
],
"operationId": "SearchCountPurifiers",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Purifiers/searchInfo": {
"get": {
"tags": [
"Purifiers"
],
"operationId": "SearchInfoPurifiers",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Purifiers/{purifierNo}/copy": {
"get": {
"tags": [
"Purifiers"
],
"operationId": "CopyPurifier",
"parameters": [
{
"name": "purifierNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Purifier"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Purifier_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Receivers": {
"get": {
"tags": [
"Receivers"
],
"summary": "Gets a list of Receivers",
"operationId": "GetReceivers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Receivers"
],
"summary": "Creates a new receiver record",
"operationId": "CreateReceiver",
"requestBody": {
"description": "The Receiver Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Receivers/{receiverNo}": {
"get": {
"tags": [
"Receivers"
],
"summary": "Gets a specific Receiver",
"operationId": "GetReceiver",
"parameters": [
{
"name": "receiverNo",
"in": "path",
"description": "The ReceiverNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested receiver",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an receiver with the supplied Receiver No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Receivers"
],
"summary": "Updates an existing Receiver",
"operationId": "UpdateReceiver",
"parameters": [
{
"name": "receiverNo",
"in": "path",
"description": "The ReceiverNo of the receiver to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Receiver DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Receiver object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Receivers/{receiverNo}/history": {
"get": {
"tags": [
"Receivers"
],
"summary": "Gets history for a specific Receiver",
"operationId": "GetReceiverHistory",
"parameters": [
{
"name": "receiverNo",
"in": "path",
"description": "The ReceiverNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested receiver",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an receiver with the supplied Receiver No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Receivers/search": {
"post": {
"tags": [
"Receivers"
],
"summary": "Search for Receivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchReceivers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested receiver",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Receivers/searchIndex/{receiverGuid}": {
"post": {
"tags": [
"Receivers"
],
"summary": "Get index of a record in a search for receivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexReceivers",
"parameters": [
{
"name": "receiverGuid",
"in": "path",
"description": "The receiver to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Receivers/searchCount": {
"post": {
"tags": [
"Receivers"
],
"summary": "Returns number of hits in a search for Receivers\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountReceivers",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Receivers/searchInfo": {
"get": {
"tags": [
"Receivers"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoReceivers",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Receivers/{receiverNo}/copy": {
"get": {
"tags": [
"Receivers"
],
"summary": "Copies an existing Receiver to a new object",
"operationId": "CopyReceiver",
"parameters": [
{
"name": "receiverNo",
"in": "path",
"description": "The ReceiverNo of the receiver to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Receiver object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Receivers/{receiverNo}/Documents": {
"get": {
"tags": [
"Receivers"
],
"summary": "Returns a list of Documents on the Receiver",
"operationId": "GetReceiverDocumentLinks",
"parameters": [
{
"name": "receiverNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.ReceiverDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.ReceiverDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.ReceiverDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Receivers/{receiverNo}/Documents/{documentNo}": {
"get": {
"tags": [
"Receivers"
],
"summary": "Returns a specific Document on the Receiver",
"operationId": "GetReceiverDocumentLink",
"parameters": [
{
"name": "receiverNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.ReceiverDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.ReceiverDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.ReceiverDocument"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RejectReasons": {
"get": {
"tags": [
"RejectReasons"
],
"summary": "Gets a list of RejectReasons",
"operationId": "GetRejectReasons",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"RejectReasons"
],
"summary": "Creates a new rejectReason record",
"operationId": "CreateRejectReason",
"requestBody": {
"description": "The RejectReason Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RejectReason_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RejectReasons/{reasonNo}": {
"get": {
"tags": [
"RejectReasons"
],
"summary": "Gets a specific RejectReason",
"operationId": "GetRejectReason",
"parameters": [
{
"name": "reasonNo",
"in": "path",
"description": "The ReasonNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested rejectReason",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an rejectReason with the supplied Reason No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"RejectReasons"
],
"summary": "Updates an existing RejectReason",
"operationId": "UpdateRejectReason",
"parameters": [
{
"name": "reasonNo",
"in": "path",
"description": "The ReasonNo of the rejectReason to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The RejectReason DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated RejectReason object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RejectReason_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"RejectReasons"
],
"summary": "Deletes a rejectReason record",
"parameters": [
{
"name": "reasonNo",
"in": "path",
"description": "The ReasonNo of the RejectReason to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RejectReason_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RejectReasons/{reasonNo}/history": {
"get": {
"tags": [
"RejectReasons"
],
"summary": "Gets history for a specific RejectReason",
"operationId": "GetRejectReasonHistory",
"parameters": [
{
"name": "reasonNo",
"in": "path",
"description": "The ReasonNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested rejectReason",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an rejectReason with the supplied Reason No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RejectReason_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RejectReasons/search": {
"post": {
"tags": [
"RejectReasons"
],
"summary": "Search for RejectReasons\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchRejectReasons",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested rejectReason",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RejectReasons/searchIndex/{reasonGuid}": {
"post": {
"tags": [
"RejectReasons"
],
"summary": "Get index of a record in a search for rejectReasons\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexRejectReasons",
"parameters": [
{
"name": "reasonGuid",
"in": "path",
"description": "The rejectReason to find index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RejectReasons/searchCount": {
"post": {
"tags": [
"RejectReasons"
],
"summary": "Returns number of hits in a search for RejectReasons\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountRejectReasons",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RejectReasons/searchInfo": {
"get": {
"tags": [
"RejectReasons"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoRejectReasons",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/RejectReasons/{reasonNo}/copy": {
"get": {
"tags": [
"RejectReasons"
],
"summary": "Copies an existing RejectReason to a new object",
"operationId": "CopyRejectReason",
"parameters": [
{
"name": "reasonNo",
"in": "path",
"description": "The ReasonNo of the rejectReason to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new RejectReason object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReason"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RejectReason_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RejectReasons/{reasonNo}/restrictions": {
"get": {
"tags": [
"RejectReasons"
],
"summary": "Fetches all restriction types attached to the rejection reason",
"operationId": "GetRejectReasonRestrictions",
"parameters": [
{
"name": "reasonNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the restriction types for the rejection reason",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReasonRestriction"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReasonRestriction"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReasonRestriction"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Reminders": {
"get": {
"tags": [
"Reminders"
],
"summary": "Gets a list of reminders",
"operationId": "GetReminders",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "The page size",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.Reminder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.Reminder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.Reminder"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Reminders/search": {
"post": {
"tags": [
"Reminders"
],
"summary": "Search for reminders\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchReminders",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "The page size",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.Reminder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.Reminder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.Reminder"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Reminders/searchCount": {
"post": {
"tags": [
"Reminders"
],
"summary": "Returns number of hits in a search for reminders\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountReminders",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Reminders/searchIndex/{reminderGuid}": {
"post": {
"tags": [
"Reminders"
],
"summary": "Get index of a record in a search for reminders\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexReminders",
"parameters": [
{
"name": "reminderGuid",
"in": "path",
"description": "The reminder to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Reminders/searchInfo": {
"get": {
"tags": [
"Reminders"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoReminders",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Reminders/actions/generate": {
"post": {
"tags": [
"Reminders"
],
"summary": "Generates reminders based on current data",
"operationId": "GenerateReminders",
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Reminders/{reminderGuid}/emaildetails": {
"get": {
"tags": [
"Reminders"
],
"summary": "Gets email details for a specific reminder",
"operationId": "GetReminderEmailDetails",
"parameters": [
{
"name": "reminderGuid",
"in": "path",
"description": "The reminder Guid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns reminder email details",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.ReminderEmailDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.ReminderEmailDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.ReminderEmailDetails"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request"
},
"404": {
"description": "If a reminder with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets a list of Requiositions",
"operationId": "GetRequestForQuotes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Creates a new requestForQuote record",
"operationId": "CreateRequestForQuote",
"requestBody": {
"description": "The requestForQuote Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets a specific RequestForQuote",
"operationId": "GetRequestForQuote",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "the requestForQuoteNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested requestForQuote",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an requestForQuote with the supplied RequestForQuote No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"RequestForQuotes"
],
"summary": "Updates an existing requestForQuote",
"operationId": "UpdateRequestForQuote",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The requestForQuote of the requestForQuote to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The requestForQuote DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated RequestForQuote object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"RequestForQuotes"
],
"summary": "Deletes an requestForQuote record",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The requestForQuoteNo of the requestForQuote to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/history": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets history for a specific RequestForQuote",
"operationId": "GetRequestForQuoteHistory",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The requestForQuoteNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested requestForQuote",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an requestForQuote with the supplied RequestForQuote No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/search": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Search for requestForQuotes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchRequestForQuotes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/searchCount": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Returns number of hits in a search for RequestForQuotes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountRequestForQuotes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/searchIndex/{requestForQuoteGuid}": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Get index of a record in a search for RequestForQuotes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexRequestForQuotes",
"parameters": [
{
"name": "requestForQuoteGuid",
"in": "path",
"description": "The requestForQuote to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/searchInfo": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoRequestForQuotes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/RequestForQuotes/{requestForQuoteNo}/copy": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Copies an existing requestForQuote to a new object",
"operationId": "CopyRequestForQuote",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The RequestForQuoteNo of the requestForQuote to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new RequestForQuote object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/standardTexts": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets a list of RFQ standard texts",
"operationId": "GetRequestForQuoteStandardTexts",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The RFQ no. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteStandardText"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteStandardText"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteStandardText"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/deliveryCosts": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets a list of RFQ delivery costs",
"operationId": "GetRequestForQuoteDeliveryCosts",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The RFQ no. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteDeliveryCost"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteDeliveryCost"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteDeliveryCost"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/responses": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets a list of requestForQuote responses",
"operationId": "GetRequestForQuoteResponses",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The requestForQuote no. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/responses/count": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Returns number of RequestForQuoteResponses for RequestForQuoteNo",
"operationId": "CountRequestForQuoteResponses",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The RequestForQuoteNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/addResponse": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Add response",
"operationId": "AddRequestForQuoteResponse",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The RequestForQuoteNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The RequestForQuoteResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/positions": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets a list of RequestForQuote positions",
"operationId": "GetRequestForQuotePositions",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The RequestForQuote No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/documents": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Returns a list of Documents used on the RequestForQuote",
"operationId": "GetRequestForQuoteDocuments",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The RequestForQuoteno to fetch documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the documents for the requestForQuote",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/createrfqs": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Creates RFQ's from a Requisition. A RFQ will be created for each supplier argument.",
"operationId": "CreateRfqs",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatorArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatorArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatorArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatorArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/requisitions": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets a list of linked Requisitions",
"operationId": "GetRequestForQuoteRequisitions",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteRequisitionView"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteRequisitionView"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteRequisitionView"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/purchaseOrders": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Returns a list of Purchase Orders used on the RequestForQuote",
"operationId": "GetRequestForQuotePurchaseOrders",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The RequestForQuoteno to fetch documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the documents for the requestForQuote",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePurchaseOrder"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePurchaseOrder"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePurchaseOrder"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/reports": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets dynamic reports to print",
"operationId": "GetRequestForQuoteReportsFromUserSettings",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "override dynamic report",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested purchase order report as pdf"
},
"404": {
"description": "If a requestForQuote with the supplied purchase order No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNos}/reports": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets dynamic reports to print",
"operationId": "GetRequestForQuoteReports",
"parameters": [
{
"name": "requestForQuoteNos",
"in": "path",
"description": "A comma separated list of request for quote numbers to report",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "override dynamic report",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested purchase order report as pdf"
},
"404": {
"description": "If a requestForQuote with the supplied purchase order No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/requestforquotes/{requestForQuoteNo}/sendtoemail": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Send request for quote to supplier",
"operationId": "SendRequestForQuoteToEmail",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The requestForQuoteNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ApiMail DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/requestforquotemailattachments": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetAttachmentsForRequestForQuote",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "The RequestForQuoteNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteMailAttachmentView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteMailAttachmentView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteMailAttachmentView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/setupCreatePurchaseOrder": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Determine if a Purchase Order can be created",
"operationId": "RequestForQuoteSetupCreatePurchaseOrder",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiRequestForQuoteCreatePurchaseOrderResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiRequestForQuoteCreatePurchaseOrderResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiRequestForQuoteCreatePurchaseOrderResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/createPurchaseOrder": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Create a Purchase Order",
"operationId": "RequestForQuoteCreatePurchaseOrder",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderCreatorArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderCreatorArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderCreatorArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderCreatorArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiRequestForQuoteCreatePurchaseOrderResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiRequestForQuoteCreatePurchaseOrderResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiRequestForQuoteCreatePurchaseOrderResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/changeStatus": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Changes status on a Request For Quote",
"operationId": "RequestForQuoteChangeStatus",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteStatusChangerArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteStatusChangerArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteStatusChangerArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteStatusChangerArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteStatusChangeResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteStatusChangeResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteStatusChangeResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/mail": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Get the Request For Quote Mail used as template for Send To Supplier",
"operationId": "ApiMail",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RfqSendToSupplierArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RfqSendToSupplierArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RfqSendToSupplierArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RfqSendToSupplierArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/combineRequisitionPositions": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Combines requisition positions into request for quotes",
"operationId": "RfqCombineRequisitionPositions",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/allowSendToSupplier": {
"get": {
"tags": [
"RequestForQuotes"
],
"summary": "Determine if a quote request can be send to supplier for a RFQ",
"operationId": "RfqAllowSendToSupplier",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/{requestForQuoteNo}/sendToSupplier": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Send a quote request to supplier.",
"operationId": "RfqSendToSupplier",
"parameters": [
{
"name": "requestForQuoteNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RfqSendToSupplierArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RfqSendToSupplierArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RfqSendToSupplierArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RfqSendToSupplierArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequestForQuotes/getExistingForCombine": {
"post": {
"tags": [
"RequestForQuotes"
],
"summary": "Get list of existing RFQ's for adding applied REQ positions",
"operationId": "RfqGetExistingForCombine",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| RequestForQuote | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequisitionPositions/search": {
"post": {
"tags": [
"RequisitionPositions"
],
"summary": "Search for requisition positions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchRequisitionPositions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequisitionPositions/searchCount": {
"post": {
"tags": [
"RequisitionPositions"
],
"summary": "Returns number of hits in a search for Requisition Positions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountRequisitionPositions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequisitionPositions/searchIndex/{requisitionPositionGuid}": {
"post": {
"tags": [
"RequisitionPositions"
],
"summary": "Get index of a record in a search for Requisition Positions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexRequisitionPositions",
"parameters": [
{
"name": "requisitionPositionGuid",
"in": "path",
"description": "The requisition to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/RequisitionPositions/searchInfo": {
"get": {
"tags": [
"RequisitionPositions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoRequisitionPositions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/RequisitionPositions/getForTasklistNode": {
"post": {
"tags": [
"RequisitionPositions"
],
"summary": "Gets reqiositions for selected nodeType",
"operationId": "GetForTasklistNode",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets a list of Requiositions",
"operationId": "GetRequisitions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Requisitions"
],
"summary": "Creates a new requisition record",
"operationId": "CreateRequisition",
"requestBody": {
"description": "The requisition Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets a specific Requisition",
"operationId": "GetRequisition",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "the requisitionNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested requisition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an requisition with the supplied Requisition No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Requisitions"
],
"summary": "Updates an existing requisition",
"operationId": "UpdateRequisition",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The requisition of the requisition to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The requisition DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Requisition object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Requisitions"
],
"summary": "Deletes an requisition record",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The requisitionNo of the requisition to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/history": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets history for a specific Requisition",
"operationId": "GetRequisitionHistory",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The requisitionNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested requisition",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an requisition with the supplied Requisition No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/search": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Search for requisitions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchRequisitions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/searchCount": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Returns number of hits in a search for Requisitions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountRequisitions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/searchIndex/{requisitionGuid}": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Get index of a record in a search for Requisitions\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexRequisitions",
"parameters": [
{
"name": "requisitionGuid",
"in": "path",
"description": "The requisition to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/searchInfo": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoRequisitions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Requisitions/{requisitionNo}/copy": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Copies an existing requisition to a new object",
"operationId": "CopyRequisition",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The RequisitionNo of the requisition to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Requisition object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/responses": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets a list of requisition responses",
"operationId": "GetRequisitionResponses",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The requisition no. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/responses/count": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Returns number of RequisitionResponses for RequisitionNo",
"operationId": "CountRequisitionResponses",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The RequisitionNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/addResponse": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Add response",
"operationId": "AddRequisitionResponse",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The RequisitionNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The RequisitionResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/standardTexts": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets a list of requisition standard texts",
"operationId": "GetRequisitionStandardTexts",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The requisition no. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionStandardText"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionStandardText"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionStandardText"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/components": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets a list of requisition components",
"operationId": "GetRequisitionComponents",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The requisition no. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionComponent"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionComponent"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionComponent"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/jobs": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets a list of requisition jobs",
"operationId": "GetRequisitionJobs",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The requisition no. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionJob"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionJob"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionJob"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/positions": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets a list of Requisitions positions",
"operationId": "GetRequisitionPositions",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The Requisition No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/documents": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Returns a list of Documents used on the Requisition",
"operationId": "GetRequisitionDocuments",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The Requisitionno to fetch triggers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the triggers for the requisition",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/documents/{documentNo}": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Returns a specific requisition document",
"operationId": "GetRequisitionDocument",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The Requisitionno",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentNo",
"in": "path",
"description": "The no of the document to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the document for the requisition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionDocument"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionDocument"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionDocument"
}
}
}
},
"404": {
"description": "If a requisition document with the supplied document no cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/forwardforhandling": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Forwards a not requested requisition for further handling",
"operationId": "RequisitionForwardForHandling",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForHandlingArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForHandlingArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForHandlingArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForHandlingArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_AllowOrder | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/canapproveforrfq": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Determine if a requisition can be approved for request for quote",
"operationId": "RequisitionCanApproveForRfq",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "PositionNoApprovalList: If empty - the entire requisition will be evaluated. If not empty - only the specified position no's will be evaluated",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForRFQArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForRFQArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForRFQArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForRFQArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/approveforrfq": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Approves a requisition for request for quote",
"operationId": "RequisitionApproveForRfq",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "PositionNoApprovalList: If empty - the entire requisition will be approved. If not empty - only the specified position no's will be approved",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForRFQArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForRFQArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForRFQArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForRFQArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_TechnicalApproval | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/canreject": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Determine if a requisition can be rejected",
"operationId": "RequisitionCanReject",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "PositionNoApprovalList: If empty - the entire requisition will be evaluated. If not empty - only the specified position no's will be evaluated",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRejectArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRejectArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRejectArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRejectArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/reject": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Rejects a requisition",
"operationId": "RequisitionReject",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "PositionNoApprovalList: If empty - the entire requisition will be rejected. If not empty - only the specified position no's will be rejected",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRejectArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRejectArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRejectArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRejectArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.ApiRequisitionRejectHandler+ApiRequisitionRejectHandlerResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.ApiRequisitionRejectHandler+ApiRequisitionRejectHandlerResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.ApiRequisitionRejectHandler+ApiRequisitionRejectHandlerResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_TechnicalApproval | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/canrequestUnitrespecification": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Determine if request unit respecification is possible for a requisition",
"operationId": "RequisitionCanRequestUnitRespecification",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/requestUnitrespecification": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Request unit respecification for a requisition",
"operationId": "RequestUnitRespecification",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRequestUnitRespecificationArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRequestUnitRespecificationArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRequestUnitRespecificationArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionRequestUnitRespecificationArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/canforwardfortechnicalapproval": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Determine if a requisition acn be forwarded for technical approval",
"operationId": "RequisitionCanForwardForTechnicalApproval",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "PositionNoTechnicalApprovalList: If empty - the entire requisition will be evaluated. If not empty - only the specified position no's will be evaluated",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForTechnicalApprovalArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForTechnicalApprovalArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForTechnicalApprovalArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForTechnicalApprovalArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/forwardfortechnicalapproval": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Forward a requisition for technical approval",
"operationId": "RequisitionForwardForTechnicalApproval",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "PositionNoTechnicalApprovalList: If empty - the entire requisition will be forwarded for technical approval. If not empty - only the specified position no's will be forwarded for technical approval.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForTechnicalApprovalArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForTechnicalApprovalArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForTechnicalApprovalArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionForwardForTechnicalApprovalArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_TechnicalApproval | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/canapproveforpurchase": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Determine if a requisition can be approved for purchase",
"operationId": "RequisitionCanApproveForPurchase",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "PositionNoApprovalList: If empty - the entire requisition will be evaluated. If not empty - only the specified position no's will be evaluated",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForPurchaseArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForPurchaseArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForPurchaseArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForPurchaseArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/approveforpurchase": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Approves a requisition for purchase",
"operationId": "RequisitionApproveForPurchase",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "PositionNoApprovalList: If empty - the entire requisition will be approved. If not empty - only the specified position no's will be approved",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForPurchaseArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForPurchaseArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForPurchaseArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionApproveForPurchaseArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_TechnicalApproval | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/ordereditems": {
"get": {
"tags": [
"Requisitions"
],
"operationId": "RequisitionOrderedItems",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.PositionOrderedOrRequested"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.PositionOrderedOrRequested"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.PositionOrderedOrRequested"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/addremark": {
"post": {
"tags": [
"Requisitions"
],
"operationId": "RequisitionAddRemark",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.RequisitionsController+RequisitionRemark"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.RequisitionsController+RequisitionRemark"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.RequisitionsController+RequisitionRemark"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.RequisitionsController+RequisitionRemark"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/requestForQuotes": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets a list of linked RFQ's",
"operationId": "GetRequisitionRequestForQuotes",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The Requisition No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionRequestForQuoteView"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionRequestForQuoteView"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionRequestForQuoteView"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/createPurchaseOrder": {
"post": {
"tags": [
"Requisitions"
],
"operationId": "RequisitionCreatePurchaseOrder",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderCreatorArguments"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderCreatorArguments"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderCreatorArguments"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderCreatorArguments"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiRequisitionCreatePurchaseOrderResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiRequisitionCreatePurchaseOrderResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.ApiRequisitionCreatePurchaseOrderResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaProcurement |
| ProcurementFlowExternalSystem |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/reports": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets dynamic reports to print",
"operationId": "GetRequisitionReportsFromUserSettings",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "override dynamic report",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested purchase order report as pdf"
},
"404": {
"description": "If a purchaseOrder with the supplied purchase order No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNos}/reports": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets dynamic reports to print",
"operationId": "GetRequisitionReports",
"parameters": [
{
"name": "requisitionNos",
"in": "path",
"description": "A comma separated list of purchase order numbers to report",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "override dynamic report",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested purchase order report as pdf"
},
"404": {
"description": "If a purchaseOrder with the supplied purchase order No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/purchaseOrderPositions": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets a list of the Requisition's Purchase Order positions",
"operationId": "GetRequisitionPurchaseOrderPositions",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The Requisition No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| PurchaseOrder | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/punchout": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Do PunchOut",
"operationId": "GetPunchOutRequisition",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.RequisitionsController+RequisitionPunchOutAddress"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.RequisitionsController+RequisitionPunchOutAddress"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.RequisitionsController+RequisitionPunchOutAddress"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Controllers.RequisitionsController+RequisitionPunchOutAddress"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "uri"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "uri"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| PunchoutIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/getpunchoutpositions": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Get PunchOut Positions",
"operationId": "GetPunchOutPositions",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "uri"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "uri"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| PunchoutIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/returnpunchouttodraft": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Return PunchOut to Draft",
"operationId": "ReturnPunchOutToDraft",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "uri"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "uri"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "uri"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| PunchoutIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/requisitionCounts": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Gets reqiosition and requisitionPosition count for selected nodeType",
"operationId": "RequisitionCounts",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionCountView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionCountView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionCountView"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/getRequisitionsByNode": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Gets reqiositions for selected nodeType",
"operationId": "GetRequisitionsByNode",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionTasklistFilter"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/cancel": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Cancelles a local requisition",
"operationId": "RequisitionCancel",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_AllowOrder | Function |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/sendtoemail": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Send requisition to supplier",
"operationId": "SendRequisitionToEmail",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The requisitionNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ApiMail DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/mail": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Get the Requisition Mail used as template for Send To Supplier",
"operationId": "RequisitionApiMail",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/requisitionmailattachments": {
"get": {
"tags": [
"Requisitions"
],
"summary": "Gets possible mail attachments for a specific Requisition",
"operationId": "GetAttachmentsForRequisition",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The requisitionNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested documents",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionMailAttachmentView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionMailAttachmentView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionMailAttachmentView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If requisition with the supplied Requisition No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition | View |
Customer must have one of these License values set| Key | Right |
|---|
| InextiaFullProcurement |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/receive": {
"post": {
"tags": [
"Requisitions"
],
"summary": "Received positions on the Requisition with RequisitionNo.\r\nReception contains information about each position to receive.\r\nEither total of rejected and received items, or a delta to let API summarize total.\r\nIf Items are rejected a RejectRemark can be supplied as well.\r\nReturns Positions updated by the reception",
"operationId": "ReceiveRequisition",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The RequisitionNo to receive positions for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Reception object",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionReception"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionReception"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionReception"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionReception"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
| ProcurementRequisition_AllowReceive | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Requisitions/{requisitionNo}/allowReceive": {
"get": {
"tags": [
"Requisitions"
],
"summary": "",
"operationId": "AllowReceiveRequisitionr",
"parameters": [
{
"name": "requisitionNo",
"in": "path",
"description": "The PurchaseOrderNo to receive positions for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementRequisition_Update | Update |
| ProcurementRequisition_AllowReceive | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Resources": {
"get": {
"tags": [
"Resources"
],
"summary": "Gets a list of Resources",
"operationId": "GetResources",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Resources"
],
"summary": "Creates a new resource record",
"operationId": "CreateResource",
"requestBody": {
"description": "The Resource Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Resource_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Resources/{resourceNo}": {
"get": {
"tags": [
"Resources"
],
"summary": "Gets a specific Resource",
"operationId": "GetResource",
"parameters": [
{
"name": "resourceNo",
"in": "path",
"description": "The ResourceNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested resource",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an resource with the supplied Resource No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Resources"
],
"summary": "Updates an existing Resource",
"operationId": "UpdateResource",
"parameters": [
{
"name": "resourceNo",
"in": "path",
"description": "The ResourceNo of the resource to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Resource DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Resource object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Resource_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Resources"
],
"summary": "Deletes a resource record",
"parameters": [
{
"name": "resourceNo",
"in": "path",
"description": "The ResourceNo of the Resource to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Resource_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Resources/{resourceNo}/history": {
"get": {
"tags": [
"Resources"
],
"summary": "Gets history for a specific Resource",
"operationId": "GetResourceHistory",
"parameters": [
{
"name": "resourceNo",
"in": "path",
"description": "The ResourceNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested resource",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an resource with the supplied Resource No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Resource_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Resources/search": {
"post": {
"tags": [
"Resources"
],
"summary": "Search for Resources\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchResources",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested resource",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Resources/searchIndex/{resourceGuid}": {
"post": {
"tags": [
"Resources"
],
"summary": "Get index of a record in a search for resources\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexResources",
"parameters": [
{
"name": "resourceGuid",
"in": "path",
"description": "The resource to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Resources/searchCount": {
"post": {
"tags": [
"Resources"
],
"summary": "Returns number of hits in a search for Resources\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountResources",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Resources/searchInfo": {
"get": {
"tags": [
"Resources"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoResources",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Resources/{resourceNo}/copy": {
"get": {
"tags": [
"Resources"
],
"summary": "Copies an existing Resources to a new object",
"operationId": "CopyResource",
"parameters": [
{
"name": "resourceNo",
"in": "path",
"description": "The ResourceNo of the resource to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Resource object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Resource.Resource"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Resource_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Roles": {
"get": {
"tags": [
"Roles"
],
"summary": "Gets a list of Roles",
"operationId": "GetRoles",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Roles"
],
"summary": "Creates a new role record",
"operationId": "CreateRole",
"requestBody": {
"description": "The Role Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Role_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Roles/{roleNo}": {
"get": {
"tags": [
"Roles"
],
"summary": "Gets a specific Role",
"operationId": "GetRole",
"parameters": [
{
"name": "roleNo",
"in": "path",
"description": "the roleNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested role",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an role with the supplied Role No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Roles"
],
"summary": "Updates an existing Role",
"operationId": "UpdateRole",
"parameters": [
{
"name": "roleNo",
"in": "path",
"description": "The roleNo of the role to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Role DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Role object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Role_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Roles"
],
"summary": "Deletes an role record",
"parameters": [
{
"name": "roleNo",
"in": "path",
"description": "The roleNo of the Role to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Role_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Roles/{roleNo}/history": {
"get": {
"tags": [
"Roles"
],
"summary": "Gets history for a specific Role",
"operationId": "GetRoleHistory",
"parameters": [
{
"name": "roleNo",
"in": "path",
"description": "The roleNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested role",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an role with the supplied Role No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Role_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Roles/search": {
"post": {
"tags": [
"Roles"
],
"summary": "Search for roles\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchRoles",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Roles/searchCount": {
"post": {
"tags": [
"Roles"
],
"summary": "Returns number of hits in a search for Roles\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountRoles",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Roles/searchIndex/{roleGuid}": {
"post": {
"tags": [
"Roles"
],
"summary": "Get index of a record in a search for Roles\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexRoles",
"parameters": [
{
"name": "roleGuid",
"in": "path",
"description": "The role to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Roles/searchInfo": {
"get": {
"tags": [
"Roles"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoRoles",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Roles/{roleNo}/copy": {
"get": {
"tags": [
"Roles"
],
"summary": "Copies an existing role to a new object",
"operationId": "CopyRole",
"parameters": [
{
"name": "roleNo",
"in": "path",
"description": "The RoleNo of the role to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Role object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.Role"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Role_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Roles/{roleNo}/units": {
"get": {
"tags": [
"Roles"
],
"operationId": "GetRoleUnits",
"parameters": [
{
"name": "roleNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks": {
"get": {
"tags": [
"ScheduledTasks"
],
"summary": "Gets a list of Scheduled Tasks",
"operationId": "GetScheduledTasks",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ScheduledTasks"
],
"summary": "Creates a new Scheduled Task record",
"operationId": "CreateScheduledTask",
"requestBody": {
"description": "The TSTask Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| TSTask_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/{taskNo}": {
"get": {
"tags": [
"ScheduledTasks"
],
"summary": "Gets a specific Scheduled Task",
"operationId": "GetScheduledTask",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "The TaskNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested task",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an task with the supplied Task No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ScheduledTasks"
],
"summary": "Updates an existing Scheduled Task",
"operationId": "UpdateScheduledTask",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "The TaskNo of the task to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The TSTask DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated TSTask object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| TSTask_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ScheduledTasks"
],
"summary": "Deletes a task record",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "The TaskNo of the Scheduled Task to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| TSTask_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/{taskNo}/history": {
"get": {
"tags": [
"ScheduledTasks"
],
"summary": "Gets history for a specific Scheduled Task",
"operationId": "GetScheduledTaskHistory",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "The TaskNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested task",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an task with the supplied TSTask No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| TSTask_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/search": {
"post": {
"tags": [
"ScheduledTasks"
],
"summary": "Search for Scheduled Tasks\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchScheduledTasks",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/searchIndex/{taskGuid}": {
"post": {
"tags": [
"ScheduledTasks"
],
"summary": "Get index of a record in a search for Scheduled Tasks\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexScheduledTasks",
"parameters": [
{
"name": "taskGuid",
"in": "path",
"description": "The task to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/searchCount": {
"post": {
"tags": [
"ScheduledTasks"
],
"summary": "Returns number of hits in a search for Scheduled Task\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountScheduledTasks",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/searchInfo": {
"get": {
"tags": [
"ScheduledTasks"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoScheduledTasks",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ScheduledTasks/{taskNo}/queueItems": {
"post": {
"tags": [
"ScheduledTasks"
],
"summary": "Returns a list of Queue Task Items used on the Scheduled Task",
"operationId": "GetScheduledTaskQueueItems",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "The TSTaskno to fetch triggers for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Returns the triggers for the task",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.QueueTSTaskItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.QueueTSTaskItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.QueueTSTaskItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/searchCount/items": {
"post": {
"tags": [
"ScheduledTasks"
],
"summary": "Returns number of hits in a search for Items on a Scheduled Task\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "ItemsSearchCountScheduledTasks",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/{taskNo}/queueItems/{queueTaskItemNo}": {
"get": {
"tags": [
"ScheduledTasks"
],
"summary": "Returns a specific queued task item",
"operationId": "GetScheduledTaskQueueItem",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "The TSTaskno",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "queueTaskItemNo",
"in": "path",
"description": "The no of the queue item to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the queue item for the task",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.QueueTSTaskItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.QueueTSTaskItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.QueueTSTaskItem"
}
}
}
},
"404": {
"description": "If a task queue item with the supplied queue item no cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/{taskNo}/copy": {
"get": {
"tags": [
"ScheduledTasks"
],
"summary": "Copies an existing Scheduled Task to a new object",
"operationId": "CopyScheduledTask",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "The TaskNo of the task to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Task object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| TSTask_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/{taskNo}/activatetask": {
"post": {
"tags": [
"ScheduledTasks"
],
"summary": "Activates a task",
"operationId": "ActivateTask",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "the task no to activate",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The time the task should run",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "date-time"
}
},
"application/*+json": {
"schema": {
"type": "string",
"format": "date-time"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| TSTask_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/{taskNo}/deactivatetask": {
"post": {
"tags": [
"ScheduledTasks"
],
"summary": "Deactivates a task",
"operationId": "DeactivateTask",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "the task no to activate",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| TSTask_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScheduledTasks/{taskNo}/RunNowTask": {
"post": {
"tags": [
"ScheduledTasks"
],
"summary": "Run a task Now",
"operationId": "RunNowTask",
"parameters": [
{
"name": "taskNo",
"in": "path",
"description": "the task no to run",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.TSTask"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| TSTask_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScreenLayouts": {
"get": {
"tags": [
"ScreenLayouts"
],
"summary": "Get a list of screenLayouts",
"operationId": "GetScreenLayouts",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ScreenLayouts"
],
"summary": "Creates a new ScreenLayout record",
"operationId": "CreateScreenLayout",
"requestBody": {
"description": "The ScreenLayout DTO object to create",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScreenLayouts/{screenLayoutKey}": {
"get": {
"tags": [
"ScreenLayouts"
],
"summary": "Gets a specific ScreenLayout",
"operationId": "GetScreenLayout",
"parameters": [
{
"name": "screenLayoutKey",
"in": "path",
"description": "The Key of the ScreenLayout object",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested ScreenLayout",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"204": {
"description": "If an GetScreenLayout with the supplied Key cannot be found, instead of 404"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ScreenLayouts"
],
"summary": "Updates an existing ScreenLayout",
"operationId": "UpdateScreenLayout",
"parameters": [
{
"name": "screenLayoutKey",
"in": "path",
"description": "The guid of the ScreenLayout object",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ScreenLayout DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ScreenLayout object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ScreenLayouts"
],
"summary": "Deletes a ScreenLayout record",
"operationId": "DeleteScreenLayout",
"parameters": [
{
"name": "screenLayoutKey",
"in": "path",
"description": "The guid of the ScreenLayout object",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ScreenLayouts/{screenLayoutKey}/force": {
"delete": {
"tags": [
"ScreenLayouts"
],
"summary": "Force Deletes a ScreenLayout record",
"operationId": "ForceDeleteScreenLayout",
"parameters": [
{
"name": "screenLayoutKey",
"in": "path",
"description": "The guid of the ScreenLayout object",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ScreenLayout_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals": {
"get": {
"tags": [
"Seals"
],
"summary": "Gets a list of Seals",
"operationId": "GetSeals",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Seals"
],
"summary": "Creates a new Seal record",
"operationId": "CreateSeal",
"requestBody": {
"description": "The Seal Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Seal_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals/{sealNo}": {
"get": {
"tags": [
"Seals"
],
"summary": "Gets a specific Seal",
"operationId": "GetSeal",
"parameters": [
{
"name": "sealNo",
"in": "path",
"description": "The Seal to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Seal",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Seal with the supplied Seal No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Seals"
],
"summary": "Updates an existing Seal",
"operationId": "UpdateSeal",
"parameters": [
{
"name": "sealNo",
"in": "path",
"description": "The SealNo of the seal to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Seal DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Seal object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Seal_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Seals"
],
"summary": "Deletes a Seal record",
"parameters": [
{
"name": "sealNo",
"in": "path",
"description": "The SealNo of the Seal to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Seal_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals/sealSubSealPoint/{sealSubSealPointNo}": {
"get": {
"tags": [
"Seals"
],
"summary": "Gets a specific Seal Sub Seal Point",
"operationId": "GetSealSubSealPoint",
"parameters": [
{
"name": "sealSubSealPointNo",
"in": "path",
"description": "The Seal to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Seal",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Seal with the supplied Seal No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals/{sealNo}/history": {
"get": {
"tags": [
"Seals"
],
"summary": "Gets history for a specific Seal",
"operationId": "GetSealHistory",
"parameters": [
{
"name": "sealNo",
"in": "path",
"description": "The Seal to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested Seal",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Seal with the supplied Seal No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Seal_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals/search": {
"post": {
"tags": [
"Seals"
],
"summary": "Search for Seal\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSeals",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested Seal",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals/searchIndex/{sealGuid}": {
"post": {
"tags": [
"Seals"
],
"summary": "Get index of a record in a search for Seal\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSealGuid",
"parameters": [
{
"name": "sealGuid",
"in": "path",
"description": "The Seal to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals/searchCount": {
"post": {
"tags": [
"Seals"
],
"summary": "Returns number of hits in a search for Seal\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSeals",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals/searchInfo": {
"get": {
"tags": [
"Seals"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSeals",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Seals/UpdateStatus": {
"post": {
"tags": [
"Seals"
],
"summary": "Bulk Updates a list of Seals",
"operationId": "BulkUpdateSealStatus",
"requestBody": {
"description": "The list of Seal DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStatusUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStatusUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStatusUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStatusUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated OperationTypeConfiguration object",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Seal_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals/SealAffix": {
"post": {
"tags": [
"Seals"
],
"operationId": "SealAffix",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Seal_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals/SealBreak": {
"post": {
"tags": [
"Seals"
],
"operationId": "SealBreak",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Seal_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Seals/{sealNo}/copy": {
"get": {
"tags": [
"Seals"
],
"summary": "Copies an existing Seal to a new object",
"operationId": "CopySeal",
"parameters": [
{
"name": "sealNo",
"in": "path",
"description": "The SealNo of the Seal to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Seal object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Seal"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Seal_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealStorageLocations": {
"get": {
"tags": [
"SealStorageLocations"
],
"summary": "Gets a list of SealStorageLocations",
"operationId": "GetSealStorageLocations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealStorageLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"SealStorageLocations"
],
"summary": "Creates a new SealStorageLocation record",
"operationId": "CreateSealStorageLocation",
"requestBody": {
"description": "The SealStorageLocation Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealStorageLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealStorageLocations/{SealStorageLocationNo}": {
"get": {
"tags": [
"SealStorageLocations"
],
"summary": "Gets a specific SealStorageLocation",
"operationId": "GetSealStorageLocation",
"parameters": [
{
"name": "SealStorageLocationNo",
"in": "path",
"description": "The SealStorageLocationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested seal type",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a seal type with the supplied seal type No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealStorageLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"SealStorageLocations"
],
"summary": "Updates an existing SealStorageLocation",
"operationId": "UpdateSealStorageLocation",
"parameters": [
{
"name": "SealStorageLocationNo",
"in": "path",
"description": "The SealStorageLocationNo of the seal type to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The SealStorageLocation DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated SealStorageLocation object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealStorageLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"SealStorageLocations"
],
"summary": "Deletes a SealStorageLocation record",
"parameters": [
{
"name": "SealStorageLocationNo",
"in": "path",
"description": "The SealStorageLocationNo of the SealStorageLocation to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealStorageLocation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealStorageLocations/{SealStorageLocationNo}/history": {
"get": {
"tags": [
"SealStorageLocations"
],
"summary": "Gets history for a specific SealStorageLocation",
"operationId": "GetSealStorageLocationHistory",
"parameters": [
{
"name": "SealStorageLocationNo",
"in": "path",
"description": "The SealStorageLocationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested SealStorageLocation",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a SealStorageLocation with the supplied SealStorageLocation No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealStorageLocation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealStorageLocations/search": {
"post": {
"tags": [
"SealStorageLocations"
],
"summary": "Search for SealStorageLocation\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSealStorageLocations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested seal type",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealStorageLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealStorageLocations/searchIndex/{SealStorageLocationGuid}": {
"post": {
"tags": [
"SealStorageLocations"
],
"summary": "Get index of a record in a search for seal types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSealStorageLocationGuid",
"parameters": [
{
"name": "SealStorageLocationGuid",
"in": "path",
"description": "The seal type to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealStorageLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealStorageLocations/searchCount": {
"post": {
"tags": [
"SealStorageLocations"
],
"summary": "Returns number of hits in a search for seal types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSealStorageLocations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealStorageLocation | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealStorageLocations/searchInfo": {
"get": {
"tags": [
"SealStorageLocations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSealStorageLocations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/SealStorageLocations/{SealStorageLocationNo}/copy": {
"get": {
"tags": [
"SealStorageLocations"
],
"summary": "Copies an existing SealStorageLocation to a new object",
"operationId": "CopySealStorageLocation",
"parameters": [
{
"name": "SealStorageLocationNo",
"in": "path",
"description": "The SealStorageLocationNo of the SealStorageLocation to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new SealStorageLocation object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealStorageLocation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealTypes": {
"get": {
"tags": [
"SealTypes"
],
"summary": "Gets a list of SealTypes",
"operationId": "GetSealTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"SealTypes"
],
"summary": "Creates a new SealType record",
"operationId": "CreateSealType",
"requestBody": {
"description": "The SealType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealTypes/{sealTypeNo}": {
"get": {
"tags": [
"SealTypes"
],
"summary": "Gets a specific SealType",
"operationId": "GetSealType",
"parameters": [
{
"name": "sealTypeNo",
"in": "path",
"description": "The SealTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested seal type",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a seal type with the supplied seal type No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"SealTypes"
],
"summary": "Updates an existing SealType",
"operationId": "UpdateSealType",
"parameters": [
{
"name": "sealTypeNo",
"in": "path",
"description": "The SealTypeNo of the seal type to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The SealType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated SealType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"SealTypes"
],
"summary": "Deletes a SealType record",
"parameters": [
{
"name": "sealTypeNo",
"in": "path",
"description": "The SealTypeNo of the SealType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealTypes/{sealTypeNo}/history": {
"get": {
"tags": [
"SealTypes"
],
"summary": "Gets history for a specific SealType",
"operationId": "GetSealTypeHistory",
"parameters": [
{
"name": "sealTypeNo",
"in": "path",
"description": "The SealTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested SealType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a SealType with the supplied SealType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealTypes/search": {
"post": {
"tags": [
"SealTypes"
],
"summary": "Search for SealType\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSealTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested seal type",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealTypes/searchIndex/{sealTypeGuid}": {
"post": {
"tags": [
"SealTypes"
],
"summary": "Get index of a record in a search for seal types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSealTypeGuid",
"parameters": [
{
"name": "sealTypeGuid",
"in": "path",
"description": "The seal type to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealTypes/searchCount": {
"post": {
"tags": [
"SealTypes"
],
"summary": "Returns number of hits in a search for seal types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSealTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SealTypes/searchInfo": {
"get": {
"tags": [
"SealTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSealTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/SealTypes/{sealTypeNo}/copy": {
"get": {
"tags": [
"SealTypes"
],
"summary": "Copies an existing SealType to a new object",
"operationId": "CopySealType",
"parameters": [
{
"name": "sealTypeNo",
"in": "path",
"description": "The SealTypeNo of the SealType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new SealType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SealType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections": {
"get": {
"tags": [
"Sections"
],
"summary": "Gets a list of Sections",
"operationId": "GetSections",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Sections"
],
"summary": "Creates a new section record",
"operationId": "CreateSection",
"requestBody": {
"description": "The Section Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Section_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/{sectionNo}": {
"get": {
"tags": [
"Sections"
],
"summary": "Gets a specific Section",
"operationId": "GetSection",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "the sectionNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested section",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an section with the supplied Section No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Sections"
],
"summary": "Updates an existing Section",
"operationId": "UpdateSection",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "The sectionNo of the section to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Section DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Section object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Section_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Sections"
],
"summary": "Deletes an section record",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "The sectionNo of the Section to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Section_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/{sectionNo}/history": {
"get": {
"tags": [
"Sections"
],
"summary": "Gets history for a specific Section",
"operationId": "GetSectionHistory",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "The sectionNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested section",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an section with the supplied Section No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Section_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/search": {
"post": {
"tags": [
"Sections"
],
"summary": "Search for sections\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSections",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/searchCount": {
"post": {
"tags": [
"Sections"
],
"summary": "Returns number of hits in a search for Sections\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSections",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/searchIndex/{sectionGuid}": {
"post": {
"tags": [
"Sections"
],
"summary": "Get index of a record in a search for Sections\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSections",
"parameters": [
{
"name": "sectionGuid",
"in": "path",
"description": "The section to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/searchInfo": {
"get": {
"tags": [
"Sections"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSections",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Sections/{sectionNo}/copy": {
"get": {
"tags": [
"Sections"
],
"summary": "Copies an existing section to a new object",
"operationId": "CopySection",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "The SectionNo of the section to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Section object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.Section"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Section_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/{sectionNo}/subsections": {
"get": {
"tags": [
"Sections"
],
"summary": "Fetches all Sub Sections attached to the Section",
"operationId": "GetSectionSections",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "The SectionNo to fetch sub sections for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the sub sections for the section",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.SectionSection"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.SectionSection"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.SectionSection"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/{sectionNo}/components": {
"get": {
"tags": [
"Sections"
],
"summary": "Gets a list of Components referencing the specific Section",
"operationId": "GetSectionComponents",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "Section that the components are referencing",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/{sectionNo}/users": {
"get": {
"tags": [
"Sections"
],
"summary": "Gets a list of Users referencing the specific Section",
"operationId": "GetSectionUsers",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "Section that the users are referencing",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/{sectionNo}/searchSectionComponents": {
"post": {
"tags": [
"Sections"
],
"summary": "Search for Components accessible by the specific Section\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSectionComponentsBySection",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/{sectionNo}/searchCountSectionComponents": {
"post": {
"tags": [
"Sections"
],
"summary": "Returns number of hits in a search for Components for the given Section\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSectionComponentsBySection",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/{sectionNo}/searchIndexSectionComponents/{componentNo}": {
"post": {
"tags": [
"Sections"
],
"summary": "Get index of a record in a search for Components for the given Section\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSectionComponentsBySection",
"parameters": [
{
"name": "sectionNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "componentGuid",
"in": "query",
"description": "The component to get index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "componentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/searchSectionComponents": {
"post": {
"tags": [
"Sections"
],
"summary": "Search for Components accessible by the specific Section\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSectionComponents",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Section_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/searchCountSectionComponents": {
"post": {
"tags": [
"Sections"
],
"summary": "Returns number of hits in a search for Components for the given Section\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSectionComponents",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Section_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Sections/searchIndexSectionComponents/{componentNo}": {
"post": {
"tags": [
"Sections"
],
"summary": "Get index of a record in a search for Components for the given Section\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSectionComponents",
"parameters": [
{
"name": "componentGuid",
"in": "query",
"description": "The component to get index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "componentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Section_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments": {
"get": {
"tags": [
"Shipments"
],
"summary": "Gets a list of Shipments",
"operationId": "GetShipments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Returns all Shipments",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Shipments"
],
"summary": "Creates a new Shipment record",
"operationId": "CreateShipment",
"requestBody": {
"description": "The Shipment Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"responses": {
"201": {
"description": "Returns the created Shipment object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}": {
"get": {
"tags": [
"Shipments"
],
"summary": "Gets a specific Shipment",
"operationId": "GetShipment",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The ShipmentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Shipment",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Shipments"
],
"summary": "Updates an existing Shipment",
"operationId": "UpdateShipment",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the Shipment to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Shipment DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Shipment object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Shipments"
],
"summary": "Deletes a Shipment record",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the Shipment to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Returns NoContent result if the Shipment is succesfully deleted"
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment_Delete | Delete |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/history": {
"get": {
"tags": [
"Shipments"
],
"summary": "Gets history for a specific Shipment",
"operationId": "GetShipmentHistory",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested Shipment history",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment_HistoryMode | HistoryMode |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{ShipmentNo}/copy": {
"get": {
"tags": [
"Shipments"
],
"summary": "Copies an existing Shipment to a new object",
"operationId": "CopyShipment",
"parameters": [
{
"name": "ShipmentNo",
"in": "path",
"description": "The ShipmentNo of the Shipment to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Shipment object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Carrier_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/searchInfo": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "ShipmentSearchInfo",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Shipments/search": {
"post": {
"tags": [
"Shipments"
],
"summary": "Search for Shipments.\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchShipments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns all Shipments matching the search criteria",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/searchCount": {
"post": {
"tags": [
"Shipments"
],
"summary": "Returns number of hits in a search for Shipments\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountShipments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns number of hits in a search for Shipments",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/searchIndex/{shipmentGuid}": {
"post": {
"tags": [
"Shipments"
],
"summary": "Get index of a record in a search for Shipments\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexShipments",
"parameters": [
{
"name": "shipmentGuid",
"in": "path",
"description": "The Shipment to find index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the index of a record in a search for Shipments or -1 if not found",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/documents": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns a list of Documents used on the Shipment",
"operationId": "GetShipmentDocuments",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to fetch Documents for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Documents for the Shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentDocument"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/destinationWarehouses": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns a list of DestinationWarehouses used on the Shipment",
"operationId": "GetShipmentDestinationWarehouses",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to fetch DestinationWarehouses for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the DestinationWarehouses for the Shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentDestinationWarehouse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentDestinationWarehouse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentDestinationWarehouse"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/markings": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns a list of Markings used on the Shipment",
"operationId": "GetShipmentMarkings",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to fetch Markings for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Markings for the Shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentMarking"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentMarking"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentMarking"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/pickupWarehouses": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns a list of PickupWarehouses used on the Shipment",
"operationId": "GetShipmentPickupWarehouses",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to fetch PickupWarehouses for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the PickupWarehouses for the Shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentPickupWarehouse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentPickupWarehouse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentPickupWarehouse"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/freightDetails": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns a list of FreightDetails used on the Shipment",
"operationId": "GetShipmentFreightDetails",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to fetch FreightDetails for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the FreightDetails for the Shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentFreightDetail"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentFreightDetail"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentFreightDetail"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/responses": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns a list of Responses used on the Shipment",
"operationId": "GetShipmentResponses",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to fetch Responses for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Responses for the Shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Shipments"
],
"summary": "Creates a new ShipmentResponse for the Shipment.",
"operationId": "CreateShipmentResponse",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No from the URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Shipment Response retrieved from the body of the post request",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
}
}
}
},
"responses": {
"200": {
"description": "Returns the created Shipment Response object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/responses/count": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns the number of Responses on a specific Shipment",
"operationId": "GetShipmentResponsesCount",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to fetch the number of Responses for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Responses Count for the Shipment",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/unassignedCarriers": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns a list of Unassigned Carriers (ShipmentCarriers) used on the Shipment",
"operationId": "GetShipmentUnassignedCarriers",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to fetch Unassigned Carriers (ShipmentCarriers) for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Unassigned Carriers (ShipmentCarriers) for the Shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentCarrier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentCarrier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentCarrier"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/markingCarriers": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns a list of all Marking Carriers used on the Shipment",
"operationId": "GetShipmentMarkingCarriers",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to fetch Marking Carriers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Marking Carriers for the Shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentCarrier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentCarrier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentCarrier"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/markings/{markingNo}/carriers": {
"get": {
"tags": [
"Shipments"
],
"summary": "Returns a list of all Marking Carriers used on a specific Marking on the Shipment",
"operationId": "GetMarkingCarriers",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No in which the specific Marking is",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "markingNo",
"in": "path",
"description": "The Marking No to fetch Marking Carriers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Marking Carriers for the Shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentCarrier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentCarrier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentCarrier"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No or a Marking with the supplied Marking No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/reports": {
"get": {
"tags": [
"Shipments"
],
"summary": "Gets shipment picking list reports based on selected report numbers from user settings.",
"operationId": "GetShipmentReportsFromUserSettings",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested shipment report as pdf"
},
"404": {
"description": "If a shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNos}/reports": {
"get": {
"tags": [
"Shipments"
],
"summary": "Gets shipment reports for the supplied shipment numbers.",
"operationId": "GetShipmentReports",
"parameters": [
{
"name": "shipmentNos",
"in": "path",
"description": "A comma separated list of shipment numbers to report",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "filename",
"in": "query",
"description": "the name for the report",
"schema": {
"type": "string"
}
},
{
"name": "specificReportNo",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested shipment report as pdf"
},
"404": {
"description": "If a shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment | View |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/send": {
"post": {
"tags": [
"Shipments"
],
"summary": "Send a specific Shipment",
"operationId": "SendShipment",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the Shipment to send",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated Shipment if successful",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/cancel": {
"post": {
"tags": [
"Shipments"
],
"summary": "Cancel a specific Shipment",
"operationId": "CancelShipment",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the Shipment to cancel",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated Shipment if successful",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/receive": {
"post": {
"tags": [
"Shipments"
],
"summary": "Receive a specific Warehouse Shipment\r\nWarning: This endpoint is not compatible with ReturnGoods flow.",
"operationId": "ReceiveWarehouseShipment",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the Shipment to receive",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unloadCarriers",
"in": "query",
"description": "Whether to unload carriers",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Returns the updated Shipment if successful",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/unreceive": {
"post": {
"tags": [
"Shipments"
],
"summary": "Unreceive a specific Warehouse Shipment",
"operationId": "UndoReceiveWarehouseShipment",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the Shipment to unreceive",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated Shipment if successful",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Shipments/{shipmentNo}/mail": {
"post": {
"tags": [
"Shipments"
],
"summary": "Mail a specific Shipment to either type Consignee or FreightForwarder",
"operationId": "MailShipment",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the Shipment to mail",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Mail request payload",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentMailRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentMailRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentMailRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentMailRequest"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Shipment if successful",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ProcurementShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ShipmentWays": {
"get": {
"tags": [
"ShipmentWays"
],
"summary": "Gets a list of ShipmentWays",
"operationId": "GetShipmentWays",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ShipmentWays"
],
"summary": "Creates a new ShipmentWay record",
"operationId": "CreateShipmentWay",
"requestBody": {
"description": "The ShipmentWay Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ShipmentWay_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ShipmentWays/{shipmentWayNo}": {
"get": {
"tags": [
"ShipmentWays"
],
"summary": "Gets a specific ShipmentWay",
"operationId": "GetShipmentWay",
"parameters": [
{
"name": "shipmentWayNo",
"in": "path",
"description": "the ShipmentWay No to get with",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested ShipmentWay",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ShipmentWay with the supplied ShipmentWay No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ShipmentWays"
],
"summary": "Updates an existing ShipmentWay",
"operationId": "UpdateShipmentWay",
"parameters": [
{
"name": "shipmentWayNo",
"in": "path",
"description": "The ShipmentWay No of the ShipmentWay to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The ShipmentWay DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ShipmentWay object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ShipmentWay_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ShipmentWays"
],
"summary": "Deletes an ShipmentWay record",
"parameters": [
{
"name": "shipmentWayNo",
"in": "path",
"description": "The ShipmentWay No of the ShipmentWay to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ShipmentWay_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ShipmentWays/{shipmentWayNo}/history": {
"get": {
"tags": [
"ShipmentWays"
],
"summary": "Gets history for a specific ShipmentWay",
"operationId": "GetShipmentWayHistory",
"parameters": [
{
"name": "shipmentWayNo",
"in": "path",
"description": "The ShipmentWay No to get with",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested ShipmentWay history",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an ShipmentWay with the supplied ShipmentWay No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ShipmentWay_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ShipmentWays/searchInfo": {
"get": {
"tags": [
"ShipmentWays"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoShipmentWays",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ShipmentWays/search": {
"post": {
"tags": [
"ShipmentWays"
],
"summary": "Search for ShipmentWays\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchShipmentWays",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ShipmentWays/searchCount": {
"post": {
"tags": [
"ShipmentWays"
],
"summary": "Returns number of hits in a search for ShipmentWays\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountShipmentWays",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ShipmentWays/searchIndex/{shipmentWayGuid}": {
"post": {
"tags": [
"ShipmentWays"
],
"summary": "Get index of a record in a search for ShipmentWays\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexShipmentWays",
"parameters": [
{
"name": "shipmentWayGuid",
"in": "path",
"description": "The ShipmentWay to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ShipmentWays/{shipmentWayNo}/copy": {
"get": {
"tags": [
"ShipmentWays"
],
"summary": "Copies an existing ShipmentWay to a new object",
"operationId": "CopyShipmentWay",
"parameters": [
{
"name": "shipmentWayNo",
"in": "path",
"description": "The ShipmentWay No of the ShipmentWay to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ShipmentWay object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentWay"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ShipmentWay_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Soundings": {
"get": {
"tags": [
"Soundings"
],
"operationId": "GetSoundings",
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Soundings"
],
"operationId": "CreateSounding",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Soundings/GetSoundingsForTank/{tankNo}": {
"get": {
"tags": [
"Soundings"
],
"operationId": "GetSoundingsForTank",
"parameters": [
{
"name": "tankNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Soundings/{soundingNo}": {
"get": {
"tags": [
"Soundings"
],
"operationId": "GetSounding",
"parameters": [
{
"name": "soundingNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Soundings/{soundingNo}/history": {
"get": {
"tags": [
"Soundings"
],
"operationId": "GetSoundingHistory",
"parameters": [
{
"name": "soundingNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Soundings/search": {
"post": {
"tags": [
"Soundings"
],
"operationId": "SearchSoundings",
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Soundings/searchIndex/{soundingGuid}": {
"post": {
"tags": [
"Soundings"
],
"operationId": "SearchIndexSoundingGuid",
"parameters": [
{
"name": "soundingGuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Soundings/searchCount": {
"post": {
"tags": [
"Soundings"
],
"operationId": "SearchCountSoundings",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Soundings/searchInfo": {
"get": {
"tags": [
"Soundings"
],
"operationId": "SearchInfoSoundings",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Soundings/{soundingNo}/copy": {
"get": {
"tags": [
"Soundings"
],
"operationId": "CopySounding",
"parameters": [
{
"name": "soundingNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Soundings/GetLatestSoundingForTank/{tankNo}": {
"get": {
"tags": [
"Soundings"
],
"operationId": "GetLatestSoundingForTank",
"parameters": [
{
"name": "tankNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Soundings/GetPreviousSoundingForTank/{operationDate}/{tankNo}": {
"get": {
"tags": [
"Soundings"
],
"operationId": "GetPreviousSoundingForTank",
"parameters": [
{
"name": "tankNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "operationDate",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingStatuses": {
"get": {
"tags": [
"SoundingStatuses"
],
"operationId": "GetSoundingStatuses",
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"SoundingStatuses"
],
"operationId": "CreateSoundingStatus",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingStatuses/{soundingStatusNo}": {
"get": {
"tags": [
"SoundingStatuses"
],
"operationId": "GetSoundingStatus",
"parameters": [
{
"name": "soundingStatusNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"SoundingStatuses"
],
"operationId": "UpdateSoundingStatus",
"parameters": [
{
"name": "soundingStatusNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"SoundingStatuses"
],
"parameters": [
{
"name": "soundingStatusNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingStatuses/{soundingStatusNo}/history": {
"get": {
"tags": [
"SoundingStatuses"
],
"operationId": "GetSoundingStatusHistory",
"parameters": [
{
"name": "soundingStatusNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingStatuses/search": {
"post": {
"tags": [
"SoundingStatuses"
],
"operationId": "SearchSoundingStatuses",
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingStatuses/searchIndex/{soundingStatusGuid}": {
"post": {
"tags": [
"SoundingStatuses"
],
"operationId": "SearchIndexSoundingStatusGuid",
"parameters": [
{
"name": "soundingStatusGuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingStatuses/searchCount": {
"post": {
"tags": [
"SoundingStatuses"
],
"operationId": "SearchCountSoundingStatuses",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingStatuses/searchInfo": {
"get": {
"tags": [
"SoundingStatuses"
],
"operationId": "SearchInfoSoundingStatuses",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/SoundingStatuses/{soundingStatusNo}/copy": {
"get": {
"tags": [
"SoundingStatuses"
],
"operationId": "CopySoundingStatus",
"parameters": [
{
"name": "soundingStatusNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingStatus"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OrbOperation_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTableDocuments": {
"get": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Gets a list of SoundingTableDocuments",
"operationId": "GetSoundingTableDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Creates a new document record",
"operationId": "CreateSoundingTableDocument",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTableDocuments/{documentNo}": {
"get": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Gets a specific SoundingTableDocument",
"operationId": "GetSoundingTableDocument",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTableDocuments/searchIndex/{documentGuid}": {
"post": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Get index of a record in a search for SoundingTableDocument\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSoundingTableDocuments",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTableDocuments/{documentNo}/history": {
"get": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Gets history for a specific SoundingTableDocument",
"operationId": "GetSoundingTableDocumentHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTableDocuments/search": {
"post": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSoundingTableDocuments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTableDocuments/searchCount": {
"post": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSoundingTableDocuments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTableDocuments/searchInfo": {
"get": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSoundingTableDocuments",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/SoundingTableDocuments/{documentNo}/pdf": {
"get": {
"tags": [
"SoundingTableDocuments"
],
"summary": "",
"operationId": "GetSoundingTableDocumentPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTableDocuments/{documentNo}/file": {
"get": {
"tags": [
"SoundingTableDocuments"
],
"summary": "",
"operationId": "GetSoundingTableDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"SoundingTableDocuments"
],
"operationId": "AddSoundingTableDocumentFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTableDocuments/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Get document pdf from guid",
"operationId": "GetSoundingTableDocumentPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTableDocuments/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"SoundingTableDocuments"
],
"summary": "Get document file from guid",
"operationId": "GetSoundingTableDocumentFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTables": {
"get": {
"tags": [
"SoundingTables"
],
"summary": "Gets a list of soundingtables",
"operationId": "GetSoundingTables",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"SoundingTables"
],
"summary": "Creates a new SoundingTable record",
"operationId": "CreateSoundingTable",
"requestBody": {
"description": "The SoundingTable Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTables/{soundingTableNo}": {
"get": {
"tags": [
"SoundingTables"
],
"summary": "Gets a specific SoundingTable",
"operationId": "GetSoundingTable",
"parameters": [
{
"name": "soundingTableNo",
"in": "path",
"description": "The SoundingTableNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested soundingTable",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an soundingTable with the supplied soundingTable No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"SoundingTables"
],
"summary": "Updates an existing SoundingTable",
"operationId": "UpdateSoundingTable",
"parameters": [
{
"name": "soundingTableNo",
"in": "path",
"description": "The SoundingTableNo of the soundingTable to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The SoundingTable DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated SoundingTable object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"SoundingTables"
],
"summary": "Deletes a SoundingTable record",
"parameters": [
{
"name": "soundingTableNo",
"in": "path",
"description": "The SoundingTableNo of the SoundingTable to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTables/{soundingTableNo}/history": {
"get": {
"tags": [
"SoundingTables"
],
"summary": "Gets history for a specific SoundingTable",
"operationId": "GetSoundingTableHistory",
"parameters": [
{
"name": "soundingTableNo",
"in": "path",
"description": "The SoundingTableNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested SoundingTable",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an SoundingTable with the supplied SoundingTable No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTables/search": {
"post": {
"tags": [
"SoundingTables"
],
"summary": "Search for SoundingTable\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSoundingTables",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested soundingTable",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTables/searchIndex/{soundingTableGuid}": {
"post": {
"tags": [
"SoundingTables"
],
"summary": "Get index of a record in a search for soundingtables\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSoundingTableGuid",
"parameters": [
{
"name": "soundingTableGuid",
"in": "path",
"description": "The soundingtable to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTables/searchCount": {
"post": {
"tags": [
"SoundingTables"
],
"summary": "Returns number of hits in a search for soundingTables\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSoundingTables",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SoundingTables/searchInfo": {
"get": {
"tags": [
"SoundingTables"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSoundingTables",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/SoundingTables/{soundingTableNo}/copy": {
"get": {
"tags": [
"SoundingTables"
],
"summary": "Copies an existing SoundingTable to a new object",
"operationId": "CopySoundingTable",
"parameters": [
{
"name": "soundingTableNo",
"in": "path",
"description": "The SoundingTableNo of the SoundingTable to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new SoundingTable object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SoundingTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/StandardTexts": {
"get": {
"tags": [
"StandardTexts"
],
"summary": "Gets a list of StandardTexts",
"operationId": "GetStandardTexts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"StandardTexts"
],
"summary": "Creates a new standardText record",
"operationId": "CreateStandardText",
"requestBody": {
"description": "The StandardText Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| StandardText_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/StandardTexts/{standardTextNo}": {
"get": {
"tags": [
"StandardTexts"
],
"summary": "Gets a specific StandardText",
"operationId": "GetStandardText",
"parameters": [
{
"name": "standardTextNo",
"in": "path",
"description": "the standardTextNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested standardText",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an standardText with the supplied StandardText No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"StandardTexts"
],
"summary": "Updates an existing StandardText",
"operationId": "UpdateStandardText",
"parameters": [
{
"name": "standardTextNo",
"in": "path",
"description": "The standardTextNo of the standardText to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The StandardText DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated StandardText object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| StandardText_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"StandardTexts"
],
"summary": "Deletes an standardText record",
"parameters": [
{
"name": "standardTextNo",
"in": "path",
"description": "The standardTextNo of the StandardText to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| StandardText_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/StandardTexts/{standardTextNo}/history": {
"get": {
"tags": [
"StandardTexts"
],
"summary": "Gets history for a specific StandardText",
"operationId": "GetStandardTextHistory",
"parameters": [
{
"name": "standardTextNo",
"in": "path",
"description": "The standardTextNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested standardText",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an standardText with the supplied StandardText No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| StandardText_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/StandardTexts/search": {
"post": {
"tags": [
"StandardTexts"
],
"summary": "Search for standardTexts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchStandardTexts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/StandardTexts/searchCount": {
"post": {
"tags": [
"StandardTexts"
],
"summary": "Returns number of hits in a search for StandardTexts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountStandardTexts",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/StandardTexts/searchIndex/{standardTextGuid}": {
"post": {
"tags": [
"StandardTexts"
],
"summary": "Get index of a record in a search for StandardTexts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexStandardTexts",
"parameters": [
{
"name": "standardTextGuid",
"in": "path",
"description": "The standardText to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/StandardTexts/searchInfo": {
"get": {
"tags": [
"StandardTexts"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoStandardTexts",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/StandardTexts/{standardTextNo}/copy": {
"get": {
"tags": [
"StandardTexts"
],
"summary": "Copies an existing standardText to a new object",
"operationId": "CopyStandardText",
"parameters": [
{
"name": "standardTextNo",
"in": "path",
"description": "The StandardTextNo of the standardText to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new StandardText object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.StandardText"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| StandardText_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/StandardTexts/{standardTextNo}/texts": {
"get": {
"tags": [
"StandardTexts"
],
"summary": "Fetches all Standard Text Languages attached to the Standard Text",
"operationId": "GetStandardTextLanguages",
"parameters": [
{
"name": "standardTextNo",
"in": "path",
"description": "The Standard Text No. to fetch Standard Text Languages for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Standard Text Languages for the Standard Text",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.StandardTextLanguage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.StandardTextLanguage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.StandardTextLanguage"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPointComponentTypes": {
"get": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Gets a list of SubSealPointComponentTypes",
"operationId": "GetSubSealPointComponentTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPointCompType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Creates a new SubSealPointComponentType record",
"operationId": "CreateSubSealPointComponentType",
"requestBody": {
"description": "The SubSealPointComponentType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPointCompType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPointComponentTypes/{SubSealPointComponentTypeNo}": {
"get": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Gets a specific SubSealPointComponentType",
"operationId": "GetSubSealPointComponentType",
"parameters": [
{
"name": "SubSealPointComponentTypeNo",
"in": "path",
"description": "The SubSealPointComponentTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested seal type",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a seal type with the supplied seal type No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPointCompType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Updates an existing SubSealPointComponentType",
"operationId": "UpdateSubSealPointComponentType",
"parameters": [
{
"name": "SubSealPointComponentTypeNo",
"in": "path",
"description": "The SubSealPointComponentTypeNo of the seal type to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The SubSealPointComponentType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated SubSealPointComponentType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPointCompType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Deletes a SubSealPointComponentType record",
"parameters": [
{
"name": "SubSealPointComponentTypeNo",
"in": "path",
"description": "The SubSealPointComponentTypeNo of the SubSealPointComponentType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPointCompType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPointComponentTypes/{SubSealPointComponentTypeNo}/history": {
"get": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Gets history for a specific SubSealPointComponentType",
"operationId": "GetSubSealPointComponentTypeHistory",
"parameters": [
{
"name": "SubSealPointComponentTypeNo",
"in": "path",
"description": "The SubSealPointComponentTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested SubSealPointComponentType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a SubSealPointComponentType with the supplied SubSealPointComponentType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPointCompType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPointComponentTypes/search": {
"post": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Search for SubSealPointComponentType\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSubSealPointComponentTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested seal type",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPointCompType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPointComponentTypes/searchIndex/{SubSealPointComponentTypeGuid}": {
"post": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Get index of a record in a search for seal types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSubSealPointComponentTypeGuid",
"parameters": [
{
"name": "SubSealPointComponentTypeGuid",
"in": "path",
"description": "The seal type to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPointCompType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPointComponentTypes/searchCount": {
"post": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Returns number of hits in a search for seal types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSubSealPointComponentTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPointCompType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPointComponentTypes/searchInfo": {
"get": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSubSealPointComponentTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/SubSealPointComponentTypes/{SubSealPointComponentTypeNo}/copy": {
"get": {
"tags": [
"SubSealPointComponentTypes"
],
"summary": "Copies an existing SubSealPointComponentType to a new object",
"operationId": "CopySubSealPointComponentType",
"parameters": [
{
"name": "SubSealPointComponentTypeNo",
"in": "path",
"description": "The SubSealPointComponentTypeNo of the SubSealPointComponentType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new SubSealPointComponentType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPointCompType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPoints": {
"get": {
"tags": [
"SubSealPoints"
],
"summary": "Gets a list of SubSealPoints",
"operationId": "GetSubSealPoints",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"SubSealPoints"
],
"summary": "Creates a new SubSealPoint record",
"operationId": "CreateSubSealPoint",
"requestBody": {
"description": "The SubSealPoint Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPoint_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPoints/{SubSealPointNo}": {
"get": {
"tags": [
"SubSealPoints"
],
"summary": "Gets a specific SubSealPoint",
"operationId": "GetSubSealPoint",
"parameters": [
{
"name": "SubSealPointNo",
"in": "path",
"description": "The SubSealPointNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested seal type",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a seal type with the supplied seal type No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"SubSealPoints"
],
"summary": "Updates an existing SubSealPoint",
"operationId": "UpdateSubSealPoint",
"parameters": [
{
"name": "SubSealPointNo",
"in": "path",
"description": "The SubSealPointNo of the seal type to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The SubSealPoint DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated SubSealPoint object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPoint_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"SubSealPoints"
],
"summary": "Deletes a SubSealPoint record",
"parameters": [
{
"name": "SubSealPointNo",
"in": "path",
"description": "The SubSealPointNo of the SubSealPoint to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPoint_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPoints/{SubSealPointNo}/history": {
"get": {
"tags": [
"SubSealPoints"
],
"summary": "Gets history for a specific SubSealPoint",
"operationId": "GetSubSealPointHistory",
"parameters": [
{
"name": "SubSealPointNo",
"in": "path",
"description": "The SubSealPointNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested SubSealPoint",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a SubSealPoint with the supplied SubSealPoint No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPoint_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPoints/{subSealPointNo}/logs/search": {
"post": {
"tags": [
"SubSealPoints"
],
"summary": "Searches the Webhooks associated with the Job.",
"operationId": "SearchSealSubSealPointLogs",
"parameters": [
{
"name": "subSealPointNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPoints/{subSealPointNo}/logs/searchCount": {
"post": {
"tags": [
"SubSealPoints"
],
"summary": "Returns number of hits in a search for the Job's Webhook Logs.\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSealSubSealPointLogsCount",
"parameters": [
{
"name": "subSealPointNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPoints/search": {
"post": {
"tags": [
"SubSealPoints"
],
"summary": "Search for SubSealPoint\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSubSealPoints",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested seal type",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPoints/searchIndex/{SubSealPointGuid}": {
"post": {
"tags": [
"SubSealPoints"
],
"summary": "Get index of a record in a search for seal types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSubSealPointGuid",
"parameters": [
{
"name": "SubSealPointGuid",
"in": "path",
"description": "The seal type to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPoints/searchCount": {
"post": {
"tags": [
"SubSealPoints"
],
"summary": "Returns number of hits in a search for seal types\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSubSealPoints",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SubSealPoints/searchInfo": {
"get": {
"tags": [
"SubSealPoints"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSubSealPoints",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/SubSealPoints/{SubSealPointNo}/copy": {
"get": {
"tags": [
"SubSealPoints"
],
"summary": "Copies an existing SubSealPoint to a new object",
"operationId": "CopySubSealPoint",
"parameters": [
{
"name": "SubSealPointNo",
"in": "path",
"description": "The SubSealPointNo of the SubSealPoint to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new SubSealPoint object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.SubSealPoint"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| SubSealPoint_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Substances": {
"get": {
"tags": [
"Substances"
],
"summary": "Gets a list of Substances",
"operationId": "GetSubstances",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Substances"
],
"summary": "Creates a new Substance record",
"operationId": "CreateSubstance",
"requestBody": {
"description": "The Substance Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Substance_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Substances/{substanceNo}": {
"get": {
"tags": [
"Substances"
],
"summary": "Gets a specific Substance",
"operationId": "GetSubstance",
"parameters": [
{
"name": "substanceNo",
"in": "path",
"description": "The SubstanceNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested substance",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an substance with the supplied substance No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Substances"
],
"summary": "Updates an existing Substance",
"operationId": "UpdateSubstance",
"parameters": [
{
"name": "substanceNo",
"in": "path",
"description": "The SubstanceNo of the substance to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Substance DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Substance object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Substance_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Substances"
],
"summary": "Deletes a Substance record",
"parameters": [
{
"name": "substanceNo",
"in": "path",
"description": "The SubstanceNo of the Substance to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Substance_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Substances/{substanceNo}/history": {
"get": {
"tags": [
"Substances"
],
"summary": "Gets history for a specific Substance",
"operationId": "GetSubstanceHistory",
"parameters": [
{
"name": "substanceNo",
"in": "path",
"description": "The SubstanceNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested Substance",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Substance with the supplied Substance No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Substance_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Substances/search": {
"post": {
"tags": [
"Substances"
],
"summary": "Search for Substance\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchSubstances",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested substance",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Substances/searchIndex/{substanceGuid}": {
"post": {
"tags": [
"Substances"
],
"summary": "Get index of a record in a search for substances\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexSubstanceGuid",
"parameters": [
{
"name": "substanceGuid",
"in": "path",
"description": "The substance to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Substances/searchCount": {
"post": {
"tags": [
"Substances"
],
"summary": "Returns number of hits in a search for substances\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountSubstances",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Substances/searchInfo": {
"get": {
"tags": [
"Substances"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSubstances",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Substances/{substanceNo}/copy": {
"get": {
"tags": [
"Substances"
],
"summary": "Copies an existing Substance to a new object",
"operationId": "CopySubstance",
"parameters": [
{
"name": "substanceNo",
"in": "path",
"description": "The SubstanceNo of the Substance to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Substance object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Substance"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Substance_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SuggestedActions/search": {
"post": {
"tags": [
"SuggestedActions"
],
"summary": "Search for suggested actions",
"operationId": "SearchSuggestedActions",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SuggestedActions/searchCount": {
"post": {
"tags": [
"SuggestedActions"
],
"summary": "Returns number of hits in a search for suggested actions",
"operationId": "SearchCountSuggestedActions",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SuggestedActions/searchIndex/{addressGuid}": {
"post": {
"tags": [
"SuggestedActions"
],
"summary": "Get index of a record in a search for suggested actions",
"operationId": "SearchIndexSuggestedActions",
"parameters": [
{
"name": "addressGuid",
"in": "path",
"description": "The address to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SuggestedActions/searchInfo": {
"get": {
"tags": [
"SuggestedActions"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoSuggestedActions",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SuggestedActions/dismiss": {
"put": {
"tags": [
"SuggestedActions"
],
"summary": "Dismiss suggested actions for suppliers",
"operationId": "DismissSuggestedActions",
"requestBody": {
"description": "Suggested actions list",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/SuggestedActions/changeClassification": {
"put": {
"tags": [
"SuggestedActions"
],
"summary": "Change address classification based on suggested actions",
"operationId": "ChangeSuggestedActionClassification",
"requestBody": {
"description": "Suggested actions list",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Address_Update | Update |
Customer must have one of these License values set"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TankOperationConfigurations": {
"get": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Gets a list of TankOperationConfigurations",
"operationId": "GetTankOperationConfigurations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Creates a new tankOperationConfiguration record",
"operationId": "CreateTankOperationConfiguration",
"requestBody": {
"description": "The TankOperationConfiguration Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TankOperationConfigurations/{tankOperationConfigurationNo}": {
"get": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Gets a specific TankOperationConfiguration",
"operationId": "GetTankOperationConfiguration",
"parameters": [
{
"name": "tankOperationConfigurationNo",
"in": "path",
"description": "The tankOperationConfigurationNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested tankOperationConfiguration",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an tankOperationConfiguration with the supplied TankOperationConfiguration No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Updates an existing TankOperationConfiguration",
"operationId": "UpdateTankOperationConfiguration",
"parameters": [
{
"name": "tankOperationConfigurationNo",
"in": "path",
"description": "The tankOperationConfigurationNo of the tankOperationConfiguration to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The TankOperationConfiguration DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated TankOperationConfiguration object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Deletes a tankOperationConfiguration record",
"parameters": [
{
"name": "tankOperationConfigurationNo",
"in": "path",
"description": "The TankOperationConfigurationNo of the TankOperationConfiguration to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TankOperationConfigurations/{tankOperationConfigurationNo}/history": {
"get": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Gets history for a specific TankOperationConfiguration",
"operationId": "GetTankOperationConfigurationHistory",
"parameters": [
{
"name": "tankOperationConfigurationNo",
"in": "path",
"description": "The TankOperationConfigurationNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested tankOperationConfiguration",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an tankOperationConfiguration with the supplied TankOperationConfiguration No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TankOperationConfigurations/search": {
"post": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Search for TankOperationConfigurations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchTankOperationConfigurations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested tankOperationConfiguration",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TankOperationConfigurations/searchIndex/{tankOperationConfigurationGuid}": {
"post": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Get index of a record in a search for tankOperationConfigurations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexTankOperationConfigurations",
"parameters": [
{
"name": "tankOperationConfigurationGuid",
"in": "path",
"description": "The tankOperationConfiguration to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TankOperationConfigurations/searchCount": {
"post": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Returns number of hits in a search for TankOperationConfigurations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountTankOperationConfigurations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TankOperationConfigurations/searchInfo": {
"get": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoTankOperationConfigurations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/TankOperationConfigurations/{tankOperationConfigurationNo}/sourcetanks": {
"get": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Get Source Tanks",
"operationId": "GetTankOperationConfigurationSourceTanks",
"parameters": [
{
"name": "tankOperationConfigurationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TankOperationConfigurations/{tankOperationConfigurationNo}/destinationtanks": {
"get": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Get Destination Tanks",
"operationId": "GetTankOperationConfigurationDestinationTanks",
"parameters": [
{
"name": "tankOperationConfigurationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TankOperationConfigurations/{tankOperationConfigurationNo}/secondDestinationtanks": {
"get": {
"tags": [
"TankOperationConfigurations"
],
"summary": "Get Second Destination Tanks",
"operationId": "GetTankOperationConfigurationSecondDestinationTanks",
"parameters": [
{
"name": "tankOperationConfigurationNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| OperationTypeConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks": {
"get": {
"tags": [
"Tanks"
],
"summary": "Gets a list of Tanks",
"operationId": "GetTanks",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Tanks"
],
"summary": "Creates a new Tank record",
"operationId": "CreateTank",
"requestBody": {
"description": "The Tank Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Tank_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/{tankNo}": {
"get": {
"tags": [
"Tanks"
],
"summary": "Gets a specific Tank",
"operationId": "GetTank",
"parameters": [
{
"name": "tankNo",
"in": "path",
"description": "The TankNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested tank",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If tank with the supplied tank No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Tanks"
],
"summary": "Updates an existing Tank",
"operationId": "UpdateTank",
"parameters": [
{
"name": "tankNo",
"in": "path",
"description": "The TankNo of the tank to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Tank DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Tank object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Tank_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Tanks"
],
"summary": "Deletes a Tank record",
"parameters": [
{
"name": "tankNo",
"in": "path",
"description": "The TankNo of the Tank to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Tank_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/{tankNo}/history": {
"get": {
"tags": [
"Tanks"
],
"summary": "Gets history for a specific Tank",
"operationId": "GetTankHistory",
"parameters": [
{
"name": "tankNo",
"in": "path",
"description": "The TankNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested Tank",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If Tank with the supplied Tank No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Tank_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/search": {
"post": {
"tags": [
"Tanks"
],
"summary": "Search for Tank\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchTanks",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested tank",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/searchIndex/{tankGuid}": {
"post": {
"tags": [
"Tanks"
],
"summary": "Get index of a record in a search for tanks\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexTankGuid",
"parameters": [
{
"name": "tankGuid",
"in": "path",
"description": "The tank to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/searchCount": {
"post": {
"tags": [
"Tanks"
],
"summary": "Returns number of hits in a search for tanks\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountTanks",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/searchInfo": {
"get": {
"tags": [
"Tanks"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoTanks",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Tanks/{tankNo}/copy": {
"get": {
"tags": [
"Tanks"
],
"summary": "Copies an existing Tank to a new object",
"operationId": "CopyTank",
"parameters": [
{
"name": "tankNo",
"in": "path",
"description": "The TankNo of the Tank to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Tank object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Tank"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Tank_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/{tankNo}/compartments": {
"get": {
"tags": [
"Tanks"
],
"summary": "Gets a list of TankCompartments positions",
"operationId": "GetTankCompartments",
"parameters": [
{
"name": "tankNo",
"in": "path",
"description": "The Tank No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankCompartment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankCompartment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankCompartment"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/{tankNo}/logbooks": {
"get": {
"tags": [
"Tanks"
],
"summary": "Gets a list of TankLogbooks positions",
"operationId": "GetTankLogbooks",
"parameters": [
{
"name": "tankNo",
"in": "path",
"description": "The Tank No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankLogbook"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankLogbook"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankLogbook"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/{tankNo}/soundingTable": {
"get": {
"tags": [
"Tanks"
],
"summary": "Get Tank Sounding Table",
"operationId": "GetTankSoundingTable",
"parameters": [
{
"name": "tankNo",
"in": "path",
"description": "The Tank No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SoundingTable"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/DailySoundingEnabledForLogbooks": {
"post": {
"tags": [
"Tanks"
],
"summary": "Is Daily Sounding Enabled for Logbooks",
"operationId": "DailySoundingEnabledForLogbooks",
"requestBody": {
"description": "The list of logbook enums that should be checked",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/AllowedProductClaasesForLogbooks": {
"post": {
"tags": [
"Tanks"
],
"summary": "Get list of allowed Product Classes for selected Logbook",
"operationId": "AllowedProductClaasesForLogbooks",
"requestBody": {
"description": "The list of logbook enums that should be checked",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookProductClass"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookProductClass"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookProductClass"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Tanks/AllowedLiquidsForTank/{tankNo}": {
"get": {
"tags": [
"Tanks"
],
"summary": "Get list of allowed Liquids for Tank",
"operationId": "AllowedLiquidsForTank",
"parameters": [
{
"name": "tankNo",
"in": "path",
"description": "The tank",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLiquid"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLiquid"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLiquid"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TechnicalAccounts": {
"get": {
"tags": [
"TechnicalAccounts"
],
"summary": "Gets a list of TechnicalAccounts",
"operationId": "GetTechnicalAccounts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"TechnicalAccounts"
],
"summary": "Creates a new technicalAccount record",
"operationId": "CreateTechnicalAccount",
"requestBody": {
"description": "The TechnicalAccount Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountSFI_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TechnicalAccounts/{technicalAccountNo}": {
"get": {
"tags": [
"TechnicalAccounts"
],
"summary": "Gets a specific TechnicalAccount",
"operationId": "GetTechnicalAccount",
"parameters": [
{
"name": "technicalAccountNo",
"in": "path",
"description": "the technicalAccountNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested technicalAccount",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an technicalAccount with the supplied TechnicalAccount No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"TechnicalAccounts"
],
"summary": "Updates an existing TechnicalAccount",
"operationId": "UpdateTechnicalAccount",
"parameters": [
{
"name": "technicalAccountNo",
"in": "path",
"description": "The technicalAccountNo of the technicalAccount to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The TechnicalAccount DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated TechnicalAccount object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountSFI_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"TechnicalAccounts"
],
"summary": "Deletes an technicalAccount record",
"parameters": [
{
"name": "technicalAccountNo",
"in": "path",
"description": "The technicalAccountNo of the TechnicalAccount to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountSFI_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TechnicalAccounts/{technicalAccountNo}/history": {
"get": {
"tags": [
"TechnicalAccounts"
],
"summary": "Gets history for a specific TechnicalAccount",
"operationId": "GetTechnicalAccountHistory",
"parameters": [
{
"name": "technicalAccountNo",
"in": "path",
"description": "The technicalAccountNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested technicalAccount",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an technicalAccount with the supplied TechnicalAccount No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountSFI_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TechnicalAccounts/search": {
"post": {
"tags": [
"TechnicalAccounts"
],
"summary": "Search for technicalAccounts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchTechnicalAccounts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TechnicalAccounts/searchCount": {
"post": {
"tags": [
"TechnicalAccounts"
],
"summary": "Returns number of hits in a search for TechnicalAccounts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountTechnicalAccounts",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TechnicalAccounts/searchIndex/{technicalAccountGuid}": {
"post": {
"tags": [
"TechnicalAccounts"
],
"summary": "Get index of a record in a search for TechnicalAccounts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexTechnicalAccounts",
"parameters": [
{
"name": "technicalAccountGuid",
"in": "path",
"description": "The technicalAccount to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TechnicalAccounts/searchInfo": {
"get": {
"tags": [
"TechnicalAccounts"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoTechnicalAccounts",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/TechnicalAccounts/{technicalAccountNo}/copy": {
"get": {
"tags": [
"TechnicalAccounts"
],
"summary": "Copies an existing technicalAccount to a new object",
"operationId": "CopyTechnicalAccount",
"parameters": [
{
"name": "technicalAccountNo",
"in": "path",
"description": "The TechnicalAccountNo of the technicalAccount to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new TechnicalAccount object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccount"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| AccountSFI_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TechnicalAccounts/{technicalAccountNo}/purchaseTypes": {
"get": {
"tags": [
"TechnicalAccounts"
],
"summary": "Fetches all Purchase Types attached to the Technical Account",
"operationId": "GetTechnicalAccountPurchaseTypes",
"parameters": [
{
"name": "technicalAccountNo",
"in": "path",
"description": "The technicalAccountNo to fetch technicalAccountUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the technicalAccount",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccountPurchaseType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccountPurchaseType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccountPurchaseType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TechnicalAccounts/{technicalAccountNo}/companies": {
"get": {
"tags": [
"TechnicalAccounts"
],
"summary": "Fetches all Companies attached to the Technical Account",
"operationId": "GetTechnicalAccountCompanyUnits",
"parameters": [
{
"name": "technicalAccountNo",
"in": "path",
"description": "The technicalAccountNo to fetch technicalAccountCompanies for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the technicalAccount",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccountCompany"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccountCompany"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccountCompany"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TransactionQueue/search": {
"post": {
"tags": [
"TransactionQueue"
],
"summary": "Search for items in Transaction Queue\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchTransactionQueue",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.TransactionQueue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.TransactionQueue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Transactions.TransactionQueue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataTransaction | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TransactionQueue/searchInfo": {
"get": {
"tags": [
"TransactionQueue"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoTransactionQueue",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/TransactionQueue/searchCount": {
"post": {
"tags": [
"TransactionQueue"
],
"summary": "Returns number \r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountTransactionQueue",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataTransaction | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TransactionQueue/searchIndex/{transactionQueueGuid}": {
"post": {
"tags": [
"TransactionQueue"
],
"summary": "Get index of a record in a search for item in the Transaction Queue\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchTransactionQueueIndex",
"parameters": [
{
"name": "transactionQueueGuid",
"in": "path",
"description": "The data transaction to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| DataTransaction | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TreeStructure": {
"get": {
"tags": [
"TreeStructure"
],
"operationId": "GetRootNodes",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.TreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.TreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.TreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TreeStructure/{nodeType}/{visibleKey}/children": {
"get": {
"tags": [
"TreeStructure"
],
"operationId": "GetChildren",
"parameters": [
{
"name": "nodeType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.NodeType"
}
},
{
"name": "visibleKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.TreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.TreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.TreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/TreeStructure/{nodeType}/{visibleKey}": {
"get": {
"tags": [
"TreeStructure"
],
"summary": "Returns a tree structure from root to where the requested object is in the tree\r\nAll nodes along the way is populated.",
"operationId": "FindNodeInTree",
"parameters": [
{
"name": "nodeType",
"in": "path",
"description": "",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.NodeType"
}
},
{
"name": "visibleKey",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.TreeStructureNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.TreeStructureNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.TreeStructureNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitCompanies": {
"get": {
"tags": [
"UnitCompanies"
],
"summary": "Gets a list of UnitCompanies",
"operationId": "GetUnitCompanies2",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"UnitCompanies"
],
"summary": "Creates a new unitCompany record",
"operationId": "CreateUnitCompany2",
"requestBody": {
"description": "The UnitCompany Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitCompany_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitCompanies/{unitCompanyNo}": {
"get": {
"tags": [
"UnitCompanies"
],
"summary": "Gets a specific UnitCompany",
"operationId": "GetUnitCompany2",
"parameters": [
{
"name": "unitCompanyNo",
"in": "path",
"description": "the unitCompanyNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested unitCompany",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an unitCompany with the supplied UnitCompany No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"UnitCompanies"
],
"summary": "Updates an existing UnitCompany",
"operationId": "UpdateUnitCompany2",
"parameters": [
{
"name": "unitCompanyNo",
"in": "path",
"description": "The unitCompanyNo of the unitCompany to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The UnitCompany DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated UnitCompany object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitCompany_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"UnitCompanies"
],
"summary": "Deletes an unitCompany record",
"parameters": [
{
"name": "unitCompanyNo",
"in": "path",
"description": "The unitCompanyNo of the UnitCompany to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitCompany_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitCompanies/{unitCompanyNo}/history": {
"get": {
"tags": [
"UnitCompanies"
],
"summary": "Gets history for a specific UnitCompany",
"operationId": "GetUnitCompanyHistory2",
"parameters": [
{
"name": "unitCompanyNo",
"in": "path",
"description": "The unitCompanyNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested unitCompany",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an unitCompany with the supplied UnitCompany No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitCompany_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitCompanies/search": {
"post": {
"tags": [
"UnitCompanies"
],
"summary": "Search for unitCompanies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchUnitCompanies2",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitCompanies/searchCount": {
"post": {
"tags": [
"UnitCompanies"
],
"summary": "Returns number of hits in a search for UnitCompanies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountUnitCompanies2",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitCompanies/searchIndex/{unitCompanyGuid}": {
"post": {
"tags": [
"UnitCompanies"
],
"summary": "Get index of a record in a search for UnitCompanies\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexUnitCompanies2",
"parameters": [
{
"name": "unitCompanyGuid",
"in": "path",
"description": "The unitCompany to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitCompanies/searchInfo": {
"get": {
"tags": [
"UnitCompanies"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoUnitCompanies2",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/UnitCompanies/{unitCompanyNo}/copy": {
"get": {
"tags": [
"UnitCompanies"
],
"summary": "Copies an existing unitCompany to a new object",
"operationId": "CopyUnitCompany2",
"parameters": [
{
"name": "unitCompanyNo",
"in": "path",
"description": "The UnitCompanyNo of the unitCompany to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new UnitCompany object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitCompany_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitCompanies/{unitCompanyNo}/standardTexts": {
"get": {
"tags": [
"UnitCompanies"
],
"summary": "Gets a list of unitCompany standard texts",
"operationId": "GetUnitCompany2StandardTexts",
"parameters": [
{
"name": "unitCompanyNo",
"in": "path",
"description": "The unitCompany no. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2StandardText"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2StandardText"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2StandardText"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitCompanies/{unitCompanyNo}/setAsDefault": {
"post": {
"tags": [
"UnitCompanies"
],
"summary": "Set Unit Compamy as default",
"operationId": "SetUnitCompanyAsDefault",
"parameters": [
{
"name": "unitCompanyNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitCompany_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitGroups": {
"get": {
"tags": [
"UnitGroups"
],
"summary": "Gets a list of UnitGroups",
"operationId": "GetUnitGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"UnitGroups"
],
"summary": "Creates a new unitGroup record",
"operationId": "CreateUnitGroup",
"requestBody": {
"description": "The UnitGroup Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitGroups/{unitGroupNo}": {
"get": {
"tags": [
"UnitGroups"
],
"summary": "Gets a specific UnitGroup",
"operationId": "GetUnitGroup",
"parameters": [
{
"name": "unitGroupNo",
"in": "path",
"description": "the unitGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested unitGroup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an unitGroup with the supplied UnitGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"UnitGroups"
],
"summary": "Updates an existing UnitGroup",
"operationId": "UpdateUnitGroup",
"parameters": [
{
"name": "unitGroupNo",
"in": "path",
"description": "The unitGroupNo of the unitGroup to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The UnitGroup DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated UnitGroup object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"UnitGroups"
],
"summary": "Deletes an unitGroup record",
"parameters": [
{
"name": "unitGroupNo",
"in": "path",
"description": "The unitGroupNo of the UnitGroup to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitGroup_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitGroups/{unitGroupNo}/history": {
"get": {
"tags": [
"UnitGroups"
],
"summary": "Gets history for a specific UnitGroup",
"operationId": "GetUnitGroupHistory",
"parameters": [
{
"name": "unitGroupNo",
"in": "path",
"description": "The unitGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested unitGroup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an unitGroup with the supplied UnitGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitGroup_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitGroups/search": {
"post": {
"tags": [
"UnitGroups"
],
"summary": "Search for unitGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchUnitGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitGroups/searchCount": {
"post": {
"tags": [
"UnitGroups"
],
"summary": "Returns number of hits in a search for UnitGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountUnitGroups",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitGroups/searchIndex/{unitGroupGuid}": {
"post": {
"tags": [
"UnitGroups"
],
"summary": "Get index of a record in a search for UnitGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexUnitGroups",
"parameters": [
{
"name": "unitGroupGuid",
"in": "path",
"description": "The unitGroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitGroups/searchInfo": {
"get": {
"tags": [
"UnitGroups"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoUnitGroups",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/UnitGroups/{unitGroupNo}/copy": {
"get": {
"tags": [
"UnitGroups"
],
"summary": "Copies an existing unitGroup to a new object",
"operationId": "CopyUnitGroup",
"parameters": [
{
"name": "unitGroupNo",
"in": "path",
"description": "The UnitGroupNo of the unitGroup to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new UnitGroup object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitGroups/{unitGroupNo}/units": {
"get": {
"tags": [
"UnitGroups"
],
"summary": "Fetches all Units attached to the Unit Group",
"operationId": "GetUnitGroupUnits",
"parameters": [
{
"name": "unitGroupNo",
"in": "path",
"description": "The Jobno to fetch jobgroups for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the jobgroups for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroupUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroupUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroupUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units": {
"get": {
"tags": [
"Units"
],
"summary": "Gets a list of Units",
"operationId": "GetUnits",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Units"
],
"summary": "Creates a new Unit record",
"operationId": "CreateUnit",
"requestBody": {
"description": "The Unit Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Unit_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}": {
"get": {
"tags": [
"Units"
],
"summary": "Gets a specific Unit",
"operationId": "GetUnit",
"parameters": [
{
"name": "unitNo",
"in": "path",
"description": "The UnitNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested unit",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an unit with the supplied Unit No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Units"
],
"summary": "Updates an existing Unit",
"operationId": "UpdateUnit",
"parameters": [
{
"name": "unitNo",
"in": "path",
"description": "The UnitNo of the Unit to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Unit DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Unit object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Unit_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Units"
],
"summary": "Deletes a unit record",
"parameters": [
{
"name": "unitNo",
"in": "path",
"description": "The UnitNo of the Unit to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Unit_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}/history": {
"get": {
"tags": [
"Units"
],
"summary": "Gets history for a specific Unit",
"operationId": "GetUnitHistory",
"parameters": [
{
"name": "unitNo",
"in": "path",
"description": "The UnitNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested unit",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an unit with the supplied Unit No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Unit_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/search": {
"post": {
"tags": [
"Units"
],
"summary": "Search for Units\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchUnits",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Unit | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/searchIndex/{unitGuid}": {
"post": {
"tags": [
"Units"
],
"summary": "Get index of a record in a search for unit\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexUnits",
"parameters": [
{
"name": "unitGuid",
"in": "path",
"description": "The unit to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/searchCount": {
"post": {
"tags": [
"Units"
],
"summary": "Returns number of hits in a search for Units\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountUnits",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/searchInfo": {
"get": {
"tags": [
"Units"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoUnits",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Units/{unitNo}/copy": {
"get": {
"tags": [
"Units"
],
"summary": "Copies an existing Unit to a new object",
"operationId": "Copyunit",
"parameters": [
{
"name": "unitNo",
"in": "path",
"description": "The unitNo of the unit to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new unit object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Unit_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}/logins": {
"get": {
"tags": [
"Units"
],
"summary": "Gets a list of Unit User role logins.",
"operationId": "GetUnitUserRoleLogins",
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitUserRoleLogin"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitUserRoleLogin"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitUserRoleLogin"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}/deactivate": {
"post": {
"tags": [
"Units"
],
"summary": "Set Unit as inactive",
"operationId": "SetUnitInactive",
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Unit_AllowSetUnitInactive | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}/companies": {
"get": {
"tags": [
"Units"
],
"summary": "Fetches all Companies attached to the Unit",
"operationId": "GetUnitCompanies",
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the unit companies for the unit",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}/users": {
"get": {
"tags": [
"Units"
],
"summary": "Fetches all Users attached to the Unit",
"operationId": "GetUnitUsers",
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the unit users for the unit",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}/documentClasses": {
"get": {
"tags": [
"Units"
],
"summary": "Fetches all DocumentClasses attached to the Unit",
"operationId": "GetUnitDocumentClasses",
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the unit documentClasses for the unit",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitDocumentClass"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitDocumentClass"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitDocumentClass"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/licensetypes": {
"get": {
"tags": [
"Units"
],
"summary": "Gets a list of Unit License Types",
"operationId": "GetUnitLicenseTypes",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitLicenseType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitLicenseType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitLicenseType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}/image": {
"get": {
"tags": [
"Units"
],
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Units"
],
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Unit_Update | Update |
"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Units"
],
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Not Found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Unit_Update | Update |
"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}/FunctionAreas": {
"get": {
"tags": [
"Units"
],
"summary": "Returns a list of Function Areas on the Unit",
"operationId": "GetUnitFunctionAreas",
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionAreaUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionAreaUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionAreaUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}/FunctionAreas/{functionAreaNo}": {
"get": {
"tags": [
"Units"
],
"summary": "Returns a specific Function Area on the Unit",
"operationId": "GetUnitFunctionArea",
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "functionAreaNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionArea"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/{unitNo}/ais/position": {
"get": {
"tags": [
"Units"
],
"summary": "Gets the AIS reported position of the Unit.",
"operationId": "GetUnitPosition",
"parameters": [
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.Position"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.Position"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.Position"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| SpireAisIntegration |
"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Units/AllUnitsAboveVersion": {
"get": {
"tags": [
"Units"
],
"summary": "Checks if all Units are at or above the provided semantic version.\r\nInactive and not exported Units are excluded.",
"operationId": "GetIsAllUnitsAboveVersion",
"parameters": [
{
"name": "version",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Gets a list of UnitShipments",
"operationId": "GetUnitShipments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{unitShipmentNo}": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Gets a specific UnitShipment",
"operationId": "GetUnitShipment",
"parameters": [
{
"name": "unitShipmentNo",
"in": "path",
"description": "The ShipmentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Unit Shipment",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Unit Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/searchInfo": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "UnitShipmentSearchInfo",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"403": {
"description": "Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/UnitShipments/search": {
"post": {
"tags": [
"UnitShipments"
],
"summary": "Search for UnitShipments.\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchUnitShipments",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns all UnitShipments matching the search criteria",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/searchCount": {
"post": {
"tags": [
"UnitShipments"
],
"summary": "Returns number of hits in a search for UnitShipments\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountUnitShipments",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns number of hits in a search for UnitShipments",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}": {
"put": {
"tags": [
"UnitShipments"
],
"summary": "Updates an existing Shipment",
"operationId": "UpdateUnitShipment",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the UnitShipment to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The UnitShipment DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated UnitShipment object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.Shipment"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a UnitShipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"UnitShipments"
],
"summary": "Deletes a Shipment record",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the UnitShipment to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Returns NoContent result if the UnitShipment is succesfully deleted"
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a UnitShipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_Delete | Delete |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/receiveShipment": {
"post": {
"tags": [
"UnitShipments"
],
"summary": "Receives a specific Unit Shipment without marking requisitions as received.",
"operationId": "ReceiveUnitShipment",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the UnitShipment to receive",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated UnitShipment object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a UnitShipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/receiveShipmentMarkings": {
"post": {
"tags": [
"UnitShipments"
],
"summary": "Receives specific markings on a Unit Shipment without marking requisitions as received.",
"operationId": "ReceiveUnitShipmentMarkings",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the UnitShipment to receive markings on",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "List with marking nos",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated UnitShipment object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a UnitShipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/receiveRequisitions": {
"post": {
"tags": [
"UnitShipments"
],
"summary": "Receives all requisitions on a specific Unit Shipment.",
"operationId": "ReceiveUnitShipmentRequisitions",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No of the UnitShipment to receive requisitions for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated UnitShipment object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a UnitShipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/history": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Gets history for a specific UnitShipment",
"operationId": "GetUnitShipmentHistory",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The Shipment No to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested Shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipment"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Shipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/markings": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Returns a list of Markings used on the UnitShipment",
"operationId": "GetUnitShipmentMarkings",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The UnitShipment No to fetch Markings for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Markings for the UnitShipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarking"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarking"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarking"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/markingCarriers": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Returns a list of all Marking Carriers used on the UnitShipment",
"operationId": "GetUnitShipmentMarkingCarriers",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The UnitShipment No to fetch Marking Carriers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Marking Carriers for the UnitShipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrier"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a UnitShipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/markings/{markingNo}/carriers": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Returns a list of all Marking Carriers used on a specific Marking on the UnitShipment",
"operationId": "GetUnitMarkingCarriers",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The UnitShipment No in which the specific Marking is",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "markingNo",
"in": "path",
"description": "The Marking No to fetch Marking Carriers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Marking Carriers for the UnitShipment Marking",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrier"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrier"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrier"
}
}
}
}
},
"400": {
"description": "Returns a validation result",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a UnitShipment with the supplied Shipment No or a Marking with the supplied Marking No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/responses": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Returns a list of Responses used on the UnitShipment",
"operationId": "GetUnitShipmentResponses",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The UnitShipment No to fetch Responses for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Responses for the UnitShipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentResponse"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a UnitShipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"UnitShipments"
],
"summary": "Creates a new UnitShipmentResponse for the UnitShipment.",
"operationId": "CreateUnitShipmentResponse",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The UnitShipment No from the URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The UnitShipment Response retrieved from the body of the post request",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentResponse"
}
}
}
},
"responses": {
"200": {
"description": "Returns the created UnitShipment Response object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentResponse"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a UnitShipment with the supplied Shipment No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UnitShipment_Update | Update |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementDistributionModule |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/responses/count": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Returns the number of Responses on a specific UnitShipment",
"operationId": "GetUnitShipmentResponsesCount",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The UnitShipment No to fetch the number of Responses for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the Responses Count for the UnitShipment",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/requisitions": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Gets a list of linked Requisitions",
"operationId": "GetUnitShipmentRequisitions",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Distribution.UnitShipmentRequisitionView"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Distribution.UnitShipmentRequisitionView"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Distribution.UnitShipmentRequisitionView"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/markingCarriers/{markingCarrierNo}/positions": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Returns carrier details for a specific UnitShipment marking carrier.",
"operationId": "GetUnitShipmentMarkingCarrierPositions",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The UnitShipment No",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "markingCarrierNo",
"in": "path",
"description": "The No of the UnitShipmentMarkingUnitCarrier",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns requisition-linked and non-linked positions for the carrier",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierPositions"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierPositions"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierPositions"
}
}
}
},
"400": {
"description": "Returns validation result",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If the UnitShipment or marking carrier cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UnitShipments/{shipmentNo}/markingCarrierPositions": {
"get": {
"tags": [
"UnitShipments"
],
"summary": "Returns carrier details for all marking carriers on a specific UnitShipment.",
"operationId": "GetUnitShipmentMarkingCarrierPositionsForShipment",
"parameters": [
{
"name": "shipmentNo",
"in": "path",
"description": "The UnitShipment No",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns requisition-linked and non-linked positions for all carriers on the shipment",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierPositions"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierPositions"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierPositions"
}
}
}
}
},
"400": {
"description": "Returns validation result",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If the UnitShipment cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Gets a list of UserGroups",
"operationId": "GetUserGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"UserGroups"
],
"summary": "Creates a new userGroup record",
"operationId": "CreateUserGroup",
"requestBody": {
"description": "The UserGroup Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UserGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/{userGroupNo}": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Gets a specific UserGroup",
"operationId": "GetUserGroup",
"parameters": [
{
"name": "userGroupNo",
"in": "path",
"description": "The UserGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested userGroup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an userGroup with the supplied UserGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"UserGroups"
],
"summary": "Updates an existing UserGroup",
"operationId": "UpdateUserGroup",
"parameters": [
{
"name": "userGroupNo",
"in": "path",
"description": "The UserGroupNo of the userGroup to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The UserGroup DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated UserGroup object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UserGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"UserGroups"
],
"summary": "Deletes a userGroup record",
"parameters": [
{
"name": "userGroupNo",
"in": "path",
"description": "The UserGroupNo of the UserGroup to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UserGroup_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/{userGroupNo}/history": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Gets history for a specific UserGroup",
"operationId": "GetUserGroupHistory",
"parameters": [
{
"name": "userGroupNo",
"in": "path",
"description": "The UserGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested userGroup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an userGroup with the supplied UserGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UserGroup_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/search": {
"post": {
"tags": [
"UserGroups"
],
"summary": "Search for UserGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchUserGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UserGroup | View |
| UserRight | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/searchIndex/{userGroupGuid}": {
"post": {
"tags": [
"UserGroups"
],
"summary": "Get index of a record in a search for usergroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexUserGroups",
"parameters": [
{
"name": "userGroupGuid",
"in": "path",
"description": "The userGroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/searchCount": {
"post": {
"tags": [
"UserGroups"
],
"summary": "Returns number of hits in a search for UserGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountUserGroups",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/searchInfo": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoUserGroups",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/UserGroups/{userGroupNo}/users": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Returns a list of Users associated with the User Group",
"operationId": "GetUserGroupUsers",
"parameters": [
{
"name": "userGroupNo",
"in": "path",
"description": "The UserGroupNo to fetch Users for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the userGroup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUser"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUser"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUser"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/{resourceNo}/copy": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Copies an existing UserGroup to a new object",
"operationId": "CopyUserGroup",
"parameters": [
{
"name": "resourceNo",
"in": "path",
"description": "The userGroupNo of the usergroup to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new UserGroup object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UserGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/{userGroupNo}/resourceonunits": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Fetches all Resource On Units attached to the User Group",
"operationId": "GetUserGroupResourceOnUnits",
"parameters": [
{
"name": "userGroupNo",
"in": "path",
"description": "The User No to fetch userGroupUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the userResourceOn",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/{userGroupNo}/userGroupLimitations": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Fetches all User Groups attached to the User Group",
"operationId": "GetUserGroupLimitations",
"parameters": [
{
"name": "userGroupNo",
"in": "path",
"description": "The User No to fetch userGroupUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the userResourceOn",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUserGroupLimitation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUserGroupLimitation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUserGroupLimitation"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/{userGroupNo}/assigneeonunits": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Fetches assignee on Units attached to the User Group",
"operationId": "GetUserGroupAssigneeOnUnits",
"parameters": [
{
"name": "userGroupNo",
"in": "path",
"description": "The User No to fetch userGroupAssigneeOnUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the userResourceOn",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupAssigneeOnUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupAssigneeOnUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupAssigneeOnUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/{userGroupNo}/responsibleonunits": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Fetches responsible on Units attached to the User Group",
"operationId": "GetUserGroupResponsibleOnUnits",
"parameters": [
{
"name": "userGroupNo",
"in": "path",
"description": "The User No to fetch userGroupReponsibleOnUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the userResourceOn",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupResponsibleOnUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupResponsibleOnUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupResponsibleOnUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserGroups/{userGroupNo}/jobhistoryresourceonunits": {
"get": {
"tags": [
"UserGroups"
],
"summary": "Fetches responsible on Units attached to the User Group",
"operationId": "GetUserGroupJobHistoryResourceOnUnits",
"parameters": [
{
"name": "userGroupNo",
"in": "path",
"description": "The User No to fetch userGroupJobHistoryResourceOnUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the userResourceOn",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupJobHistoryResourceOnUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupJobHistoryResourceOnUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupJobHistoryResourceOnUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserRights": {
"get": {
"tags": [
"UserRights"
],
"summary": "Gets all user rights",
"operationId": "GetUserRights",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserRight"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserRight"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserRight"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserRights/{userRightKey}/{userGroupNo}": {
"post": {
"tags": [
"UserRights"
],
"summary": "Grants the right for the specified user right key and user group no",
"operationId": "CreateUserRight",
"parameters": [
{
"name": "userRightKey",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userGroupNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserRight"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserRight"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserRight"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UserRight_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"UserRights"
],
"summary": "Revokes the right for the specified user right key and user group no",
"operationId": "DeleteUserRight",
"parameters": [
{
"name": "userRightKey",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userGroupNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserRight"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserRight"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserRight"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| UserRight_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users": {
"get": {
"tags": [
"Users"
],
"summary": "Gets a list of Users",
"operationId": "GetUsers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Users"
],
"summary": "Creates a new user record",
"operationId": "CreateUser",
"requestBody": {
"description": "The User Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}": {
"get": {
"tags": [
"Users"
],
"summary": "Gets a specific User",
"operationId": "GetUser",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The UserNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested user",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a user with the supplied User No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Users"
],
"summary": "Deletes a user record",
"operationId": "DeleteUser",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The UserNo of the User to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Users"
],
"summary": "Updates an existing User",
"operationId": "UpdateUser",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The UserNo of the user to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The User DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated User object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/history": {
"get": {
"tags": [
"Users"
],
"summary": "Gets history for a specific User",
"operationId": "GetUserHistory",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The UserNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested user",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an user with the supplied User No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/search": {
"post": {
"tags": [
"Users"
],
"summary": "Search for Users\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchUsers",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/searchCount": {
"post": {
"tags": [
"Users"
],
"summary": "Returns number of hits in a search for Users\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountUsers",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/searchIndex/{userGuid}": {
"post": {
"tags": [
"Users"
],
"summary": "Get index of a record in a search for Users\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexUsers",
"parameters": [
{
"name": "userGuid",
"in": "path",
"description": "The user number to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/searchInfo": {
"get": {
"tags": [
"Users"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoUsers",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Users/{userNo}/resend": {
"post": {
"tags": [
"Users"
],
"summary": "Resends a user welcome mail",
"operationId": "ResendUserWelcomeMail",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The UserNo of the User to resend for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{resourceNo}/copy": {
"get": {
"tags": [
"Users"
],
"summary": "Copies an existing User to a new object",
"operationId": "CopyUser",
"parameters": [
{
"name": "resourceNo",
"in": "path",
"description": "The userNo of the user to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new User object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/anonymize": {
"post": {
"tags": [
"Users"
],
"summary": "Anonymized an existing User\r\nUser properties and history will be randomized and non related to any real person.",
"operationId": "AnonymizeUser",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The UserNo of the user to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the updated User object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User_AllowAnonymizeUser | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/resetPassword": {
"post": {
"tags": [
"Users"
],
"summary": "Generates a reset password email and sends it to the user making the request - not the user for whom the reset password is requested.\r\nRequired that requester has an email address.",
"operationId": "ResetPasswordForAnotherUser",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The user for whom the password should be reset",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/units": {
"get": {
"tags": [
"Users"
],
"operationId": "GetUserUnits",
"parameters": [
{
"name": "userNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/roles": {
"get": {
"tags": [
"Users"
],
"operationId": "GetUserRoles",
"parameters": [
{
"name": "userNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/logins": {
"get": {
"tags": [
"Users"
],
"summary": "Gets a list of User Unit Role Logins.",
"operationId": "GetUserUnitRoleLogins",
"parameters": [
{
"name": "userNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnitRoleLogin"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnitRoleLogin"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnitRoleLogin"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/resourceonunits": {
"get": {
"tags": [
"Users"
],
"summary": "Fetches all Resource On Units attached to the User",
"operationId": "GetUserResourceOnUnits",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The User No to fetch userResourceOnUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the userResourceOn",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserResourceOnUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserResourceOnUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserResourceOnUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/password": {
"post": {
"tags": [
"Users"
],
"summary": "Changes a password for a specific user",
"operationId": "ChangeUserPassword",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The password information also containing userno",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ChangePasswordInformation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ChangePasswordInformation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ChangePasswordInformation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.ChangePasswordInformation"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| User_AllowSetPassword | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/assigneesonunits": {
"get": {
"tags": [
"Users"
],
"summary": "Fetches all Assignees On Units attached to the User",
"operationId": "GetUserAssigneeOnUnits",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The User No to fetch userAssigneesOnUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the userAssigneesOn",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserAssigneeOnUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserAssigneeOnUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserAssigneeOnUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/responsibleonunits": {
"get": {
"tags": [
"Users"
],
"summary": "Fetches all Responsible On Units attached to the User",
"operationId": "GetUserResponsibleOnUnits",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The User No to fetch userResponsibleOnUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the userResponsibleOnUnits",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserResponsibleOnUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserResponsibleOnUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserResponsibleOnUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/jobhistoryresourceonunits": {
"get": {
"tags": [
"Users"
],
"summary": "Fetches all JobHistoryResource units attached to the User",
"operationId": "GetUserJobHistoryResourceOnUnits",
"parameters": [
{
"name": "userNo",
"in": "path",
"description": "The User No to fetch userResponsibleOnUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the userResponsibleOnUnits",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserJobHistoryResourceOnUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserJobHistoryResourceOnUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserJobHistoryResourceOnUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Users/{userNo}/servicePrincipalMappings": {
"get": {
"tags": [
"Users"
],
"operationId": "GetUserServicePrincipalMappings",
"parameters": [
{
"name": "userNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserServicePrincipalMapping"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserServicePrincipalMapping"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserServicePrincipalMapping"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserSettings": {
"get": {
"tags": [
"UserSettings"
],
"summary": "Gets a list of InextiaUserSettings available for the current user",
"operationId": "GetUserSettings",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserSettings/{key}": {
"get": {
"tags": [
"UserSettings"
],
"summary": "Gets a specific InextiaUserSetting for current user",
"operationId": "GetUserSetting",
"parameters": [
{
"name": "key",
"in": "path",
"description": "The key to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested inextiausersetting",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"204": {
"description": "If an inextiausersetting with the supplied Key for the current user cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"UserSettings"
],
"summary": "Create/Updates an InextiaUserSetting.\r\nIf a user setting with the supplied key does not exist - it will be created. Otherwise it will be updated.",
"operationId": "UpdateUserSetting",
"parameters": [
{
"name": "key",
"in": "path",
"description": "The key of the user setting to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The value of the user setting to update",
"content": {
"application/json-patch+json": {
"schema": { }
},
"application/json": {
"schema": { }
},
"text/json": {
"schema": { }
},
"application/*+json": {
"schema": { }
}
}
},
"responses": {
"200": {
"description": "Returns the updated InextiaUserSetting object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"UserSettings"
],
"summary": "Deletes a inextiausersetting record",
"parameters": [
{
"name": "key",
"in": "path",
"description": "The Key of the InextiaUserSetting to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserSettings/search": {
"post": {
"tags": [
"UserSettings"
],
"summary": "Search for InextiaUserSettings\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchUserSettings",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested inextiausersetting",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserSetting"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserSettings/searchCount": {
"post": {
"tags": [
"UserSettings"
],
"summary": "Returns number of hits in a search for InextiaUserSettings\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountUserSettings",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/UserSettings/searchInfo": {
"get": {
"tags": [
"UserSettings"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoUserSettings",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/UserSettings/deleteAllUserSettingByKey/{key}": {
"delete": {
"tags": [
"UserSettings"
],
"summary": "Deletes all inextiausersetting records with the specified key for the grid",
"operationId": "DeleteAllUserSettingsByKey",
"parameters": [
{
"name": "key",
"in": "path",
"description": "The Key of the InextiaUserSetting to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ValueLists": {
"get": {
"tags": [
"ValueLists"
],
"summary": "Gets a list of List Of Values Templates",
"operationId": "GetListOfValuesTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"ValueLists"
],
"summary": "Creates a new List Of Values template record",
"operationId": "CreateListOfValuesTemplate",
"requestBody": {
"description": "The List Of Values Template Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ListOfValue_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ValueLists/{listOfValuesTemplateNo}": {
"get": {
"tags": [
"ValueLists"
],
"summary": "Gets a specific ListOfValuesTemplate",
"operationId": "GetListOfValuesTemplate",
"parameters": [
{
"name": "listOfValuesTemplateNo",
"in": "path",
"description": "The ListOfValuesTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested form template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form template with the supplied List Of Values Template No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"ValueLists"
],
"summary": "Updates an existing List Of Values Template",
"operationId": "UpdateListOfValuesTemplate",
"parameters": [
{
"name": "listOfValuesTemplateNo",
"in": "path",
"description": "The ListOfValuesTemplateNo of the form template to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The List Of Values Template DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated ListOfValuesTemplate object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ListOfValue_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"ValueLists"
],
"summary": "Deletes a List Of Values template record",
"parameters": [
{
"name": "listOfValuesTemplateNo",
"in": "path",
"description": "The ListOfValuesTemplateNo of the ListOfValuesTemplate to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ListOfValue_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ValueLists/{listOfValuesTemplateNo}/history": {
"get": {
"tags": [
"ValueLists"
],
"summary": "Gets history for a specific ListOfValuesTemplate",
"operationId": "GetListOfValuesTemplateHistory",
"parameters": [
{
"name": "listOfValuesTemplateNo",
"in": "path",
"description": "The ListOfValuesTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested List Of Values template",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplate"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a List Of Values template with the supplied List Of Values Template No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ListOfValue_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ValueLists/search": {
"post": {
"tags": [
"ValueLists"
],
"summary": "Search for List Of Values Templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchListOfValuesTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ValueLists/searchIndex/{ListOfValuesTemplateGuid}": {
"post": {
"tags": [
"ValueLists"
],
"summary": "Get index of a record in a search for form templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexListOfValuesTemplates",
"parameters": [
{
"name": "listOfValuesTemplateGuid",
"in": "path",
"description": "The List Of Values template to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ValueLists/searchCount": {
"post": {
"tags": [
"ValueLists"
],
"summary": "Returns number of hits in a search for Form Templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountListOfValuesTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ValueLists/searchInfo": {
"get": {
"tags": [
"ValueLists"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoListOfValuesTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/ValueLists/{listOfValuesTemplateNo}/copy": {
"get": {
"tags": [
"ValueLists"
],
"summary": "Copies an existing List Of Values Template to a new object",
"operationId": "CopyListOfValuesTemplate",
"parameters": [
{
"name": "listOfValuesTemplateNo",
"in": "path",
"description": "The ListOfValuesTemplateNo of the listOfValuesTemplate to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new ListOfValuesTemplate object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| ListOfValue_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/ValueLists/{listOfValuesTemplateNo}/templatevalues": {
"get": {
"tags": [
"ValueLists"
],
"summary": "Returns a list of ValueFields",
"operationId": "GetListOfValuesTemplateValues",
"parameters": [
{
"name": "listOfValuesTemplateNo",
"in": "path",
"description": "The TemplateNo to fetch ListOfValuesTemplate for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the values for the ListOfValuesTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplateValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplateValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplateValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VAT": {
"get": {
"tags": [
"VAT"
],
"summary": "Gets a list of VAT",
"operationId": "GetVATs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VAT"
],
"summary": "Creates a new VAT record",
"operationId": "CreateVAT",
"requestBody": {
"description": "The VAT Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VAT/{VATNo}": {
"get": {
"tags": [
"VAT"
],
"summary": "Gets a specific VAT",
"operationId": "GetVAT",
"parameters": [
{
"name": "VATNo",
"in": "path",
"description": "the VATNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested VAT",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a VAT with the supplied VAT No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VAT"
],
"summary": "Updates an existing VAT",
"operationId": "UpdateVAT",
"parameters": [
{
"name": "VATNo",
"in": "path",
"description": "The VATNo of the VAT to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The VAT DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated VAT object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VAT"
],
"summary": "Deletes an VAT record",
"parameters": [
{
"name": "VATNo",
"in": "path",
"description": "The VATNo of the VAT to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VAT/{VATNo}/history": {
"get": {
"tags": [
"VAT"
],
"summary": "Gets history for a specific VAT",
"operationId": "GetVATHistory",
"parameters": [
{
"name": "VATNo",
"in": "path",
"description": "The VATNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested VAT",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an VAT with the supplied VAT No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VAT_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VAT/search": {
"post": {
"tags": [
"VAT"
],
"summary": "Search for VATs\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVATs",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VAT/searchCount": {
"post": {
"tags": [
"VAT"
],
"summary": "Returns number of hits in a search for VAT\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVATs",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VAT/searchIndex/{VATGuid}": {
"post": {
"tags": [
"VAT"
],
"summary": "Get index of a record in a search for VAT\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVATs",
"parameters": [
{
"name": "VATGuid",
"in": "path",
"description": "The VAT to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VAT/searchInfo": {
"get": {
"tags": [
"VAT"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVATs",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VAT/{VATNo}/copy": {
"get": {
"tags": [
"VAT"
],
"summary": "Copies an existing VAT to a new object",
"operationId": "CopyVAT",
"parameters": [
{
"name": "VATNo",
"in": "path",
"description": "The VATNo of the VAT to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new VAT object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VAT.VAT"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportBrowser": {
"get": {
"tags": [
"VesselReportBrowser"
],
"summary": "",
"operationId": "GetVesselReportBrowserRootNodes",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportBrowser/{nodeType}/children": {
"post": {
"tags": [
"VesselReportBrowser"
],
"summary": "",
"operationId": "GetVesselReportBrowserChildren",
"parameters": [
{
"name": "nodeType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeType"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeKeys"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeKeys"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeKeys"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeKeys"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportBrowser/{nodeType}": {
"post": {
"tags": [
"VesselReportBrowser"
],
"summary": "",
"operationId": "GetVesselReportBrowserTree",
"parameters": [
{
"name": "nodeType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeType"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeKeys"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeKeys"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeKeys"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeKeys"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportFieldListTemplateRevisionCaches": {
"get": {
"tags": [
"VesselReportFieldListTemplateRevisionCaches"
],
"summary": "Gets a list of VesselReportFieldListTemplateRevisionCaches",
"operationId": "GetVesselReportFieldListTemplateRevisionCaches",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplateRevisionCache"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplateRevisionCache"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplateRevisionCache"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportFieldListTemplateRevisionCaches/{vesselReportTypeRevisionCacheNo}": {
"get": {
"tags": [
"VesselReportFieldListTemplateRevisionCaches"
],
"summary": "Gets a specific VesselReportFieldListTemplateRevisionCache",
"operationId": "GetVesselReportFieldListTemplateRevisionCache",
"parameters": [
{
"name": "vesselReportTypeRevisionCacheNo",
"in": "path",
"description": "the vesselReportTypeRevisionCacheNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested vesselReportTypeRevisionCache",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplateRevisionCache"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplateRevisionCache"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplateRevisionCache"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an vesselReportTypeRevisionCache with the supplied VesselReportFieldListTemplateRevisionCache No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportFieldListTemplates": {
"get": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Gets a list of List Of Values Templates",
"operationId": "GetVesselReportFieldListTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Creates a new List Of Values template record",
"operationId": "CreateVesselReportFieldListTemplate",
"requestBody": {
"description": "The List Of Values Template Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportFieldListTemplates/{vesselReportFieldListTemplateNo}": {
"get": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Gets a specific VesselReportFieldListTemplate",
"operationId": "GetVesselReportFieldListTemplate",
"parameters": [
{
"name": "vesselReportFieldListTemplateNo",
"in": "path",
"description": "The VesselReportFieldListTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested form template",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form template with the supplied List Of Values Template No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Updates an existing List Of Values Template",
"operationId": "UpdateVesselReportFieldListTemplate",
"parameters": [
{
"name": "vesselReportFieldListTemplateNo",
"in": "path",
"description": "The vesselReportFieldListTemplateNo of the form template to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The List Of Values Template DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated vesselReportFieldListTemplate object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Deletes a List Of Values template record",
"parameters": [
{
"name": "vesselReportFieldListTemplateNo",
"in": "path",
"description": "The vesselReportFieldListTemplateNo of the vesselReportFieldListTemplate to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportFieldListTemplates/{vesselReportFieldListTemplateNo}/history": {
"get": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Gets history for a specific VesselReportFieldListTemplate",
"operationId": "GetVesselReportFieldListTemplateHistory",
"parameters": [
{
"name": "vesselReportFieldListTemplateNo",
"in": "path",
"description": "The VesselReportFieldListTemplateNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested List Of Values template",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListValue"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a List Of Values template with the supplied List Of Values Template No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportFieldListTemplates/search": {
"post": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Search for VesselReportFieldListTemplate\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVesselReportFieldListTemplates",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportFieldListTemplates/searchIndex/{VesselReportFieldListTemplateGuid}": {
"post": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Get index of a record in a search for form templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVesselReportFieldListTemplates",
"parameters": [
{
"name": "vesselReportFieldListTemplateGuid",
"in": "path",
"description": "The List Of Values template to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportFieldListTemplates/searchCount": {
"post": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Returns number of hits in a search for Form Templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVesselReportFieldListTemplates",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportFieldListTemplates/searchInfo": {
"get": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVesselReportFieldListTemplates",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VesselReportFieldListTemplates/{vesselReportFieldListTemplateNo}/copy": {
"get": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Copies an existing List Of Values Template to a new object",
"operationId": "CopyVesselReportFieldListTemplate",
"parameters": [
{
"name": "vesselReportFieldListTemplateNo",
"in": "path",
"description": "The vesselReportFieldListTemplateNo of the vesselReportFieldListTemplate to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new vesselReportFieldListTemplate object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportFieldListTemplates/{vesselReportFieldListTemplateNo}/templatevalues": {
"get": {
"tags": [
"VesselReportFieldListTemplates"
],
"summary": "Returns a list of ValueFields",
"operationId": "GetVesselReportFieldListValues",
"parameters": [
{
"name": "vesselReportFieldListTemplateNo",
"in": "path",
"description": "The TemplateNo to fetch vesselReportFieldListTemplate for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the values for the vesselReportFieldListTemplate",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListValue"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListValue"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListValue"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportListTemplate | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Gets a list of VesselReports",
"operationId": "GetVesselReports",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VesselReports"
],
"summary": "Creates a new vesselReport record",
"operationId": "CreateVesselReport",
"requestBody": {
"description": "The VesselReport Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Gets a specific VesselReport",
"operationId": "GetVesselReport",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "the vesselReportNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested vesselReport",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an vesselReport with the supplied VesselReport No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VesselReports"
],
"summary": "Updates an existing VesselReport",
"operationId": "UpdateVesselReport",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The vesselReportNo of the vesselReport to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The VesselReport DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated VesselReport object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VesselReports"
],
"summary": "Deletes an vesselReport record",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The vesselReportNo of the VesselReport to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/history": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Gets history for a specific VesselReport",
"operationId": "GetVesselReportHistory",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The vesselReportNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested vesselReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an vesselReport with the supplied VesselReport No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/search": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Search for vesselReports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVesselReports",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/searchCount": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Returns number of hits in a search for VesselReports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVesselReports",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/searchIndex/{vesselReportGuid}": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Get index of a record in a search for VesselReports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVesselReports",
"parameters": [
{
"name": "vesselReportGuid",
"in": "path",
"description": "The vesselReport to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/searchInfo": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVesselReports",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VesselReports/search/{vesselReportTypeNo}": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Search for vesselReports using a specific VesselReportType\r\nTakes a Vessel Report Type No. and a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVesselReportTypeNo",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/searchInfo/{vesselReportTypeNo}": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Returns structured invesselReportation about what and how you can search for",
"operationId": "SearchInfoVesselReportsByReportTypeNo",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a list of valid search fields based on the given Vessel Report Type",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/searchCount/{vesselReportTypeNo}": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Returns number of hits in a search for VesselReports using a specific Vessel Report Type\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVesselReportsByReportTypeNo",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/searchIndex/{vesselReportGuid}/{vesselReportTypeNo}": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Get index of a record in a search for VesselReports using a specific Vessel Report Type\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVesselReportsByReportTypeNo",
"parameters": [
{
"name": "vesselReportGuid",
"in": "path",
"description": "The vesselReport to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/copy": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Copies an existing vesselReport to a new object",
"operationId": "CopyVesselReport",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The vesselReportNo of the vesselReport to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new VesselReport object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/build": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Builds a new Vessel Report record, applying default values and applies Type settings to the Report.",
"operationId": "BuildVesselReport",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBuildRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBuildRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBuildRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBuildRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBuildResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBuildResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBuildResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/approvers": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Gets the Approvers for a specific Vessel Report",
"operationId": "GetVesselReportApprovers",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested approvers",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportApprover"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportApprover"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportApprover"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Vessel Report with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/confidentialities": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Gets the Confidentialitys for a specific Vessel Report",
"operationId": "GetVesselReportConfidentialities",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Confidentialities",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Vessel Report with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/vesselReportActions": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Returns",
"operationId": "GetVesselReportActions",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportActions"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportActions"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportActions"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/approve": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Approve Vessel Report",
"operationId": "ApproveVesselReport",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The vesselReportNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/reject": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Reject Vessel Report",
"operationId": "RejectVesselReport",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The Vessel Report no to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The reason for the rejection",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportRejectReason"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportRejectReason"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportRejectReason"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportRejectReason"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/requestApproval": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Request Approval of Vessel Report",
"operationId": "RequestVesselReportApproval",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The Vessel Report no to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/approveorrequestApproval": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Approve or Request approval of Vessel Report",
"operationId": "ApproveOrRequestVesselReportApproval",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/reopen": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Request Approval of Vessel Report",
"operationId": "ReopenVesselReport",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The Vessel Report no to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Reopen | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/responses": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Gets a list of VesselReport Responses",
"operationId": "GetVesselReportResponses",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The VesselReport No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/responses/count": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Returns number of VesselReportResponses for VesselReportNo",
"operationId": "CountVesselReportResponses",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The VesselReportNo",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{VesselReportNo}/responses": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Add response",
"operationId": "AddVesselReportResponse",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "The VesselReportNo to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The VesselReportResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/nodes": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Returns a Node structure containing a mix of available and active report, report type and sequence nodes.",
"operationId": "GetVesselReportCreateNodes",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/nodes/{nodeType}/{no}/children": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Gets the child nodes of the specific node.",
"operationId": "GetVesselReportCreateNodeChildren",
"parameters": [
{
"name": "nodeType",
"in": "path",
"description": "",
"required": true,
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNodeType"
}
},
{
"name": "no",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/nodes/{query}/search": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Searches the nodes and finds any matches.",
"operationId": "SearchVesselCreateReportNodes",
"parameters": [
{
"name": "query",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/webhooklogs/search": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Searches the Webhooks associated with the Vessel Report.",
"operationId": "SearchWebhookLogs",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| WebhooksIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/webhooklogs/searchCount": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Returns number of hits in a search for the Vessel Report's Webhook Logs.\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchWebhookLogsCount",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/webhooklogs/{webhookLogGuid}/retransmit": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Retransmits a specific Webhook based on the selected Webhook Log.",
"operationId": "RetransmitWebhookLog",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookLogGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/webhooklogs/{webhookLogGuid}/resolve": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Resolves a specific Webhook Log with a Response Log entry.",
"operationId": "ResolveWebhookLog",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookLogGuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/writeupcache": {
"put": {
"tags": [
"VesselReports"
],
"summary": "Write Up Cache",
"operationId": "WriteUpCache",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_WriteUpCache | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/consumptions": {
"get": {
"tags": [
"VesselReports"
],
"summary": "Gets the Consumptions for a specific Vessel Report",
"operationId": "GetVesselReportConsumptions",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested consumptions",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportApprover"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportApprover"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportApprover"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a Vessel Report with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/webhooks/{webhookEvent}": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Runs webhooks that are of type VesselReport and active.\r\nReturns a list of validation Results with results for all found webhooks.",
"operationId": "ExecuteWebhooks",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookEvent",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_ExecuteWebhook | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/webhooks/{webhookEvent}/retryExecuteWebhooks": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Runs a list of webhooks that are of type VesselReport, active and has the same webhookNo as is recieved through the body.\r\nReturns a list of validation Results with results for all found webhooks.",
"operationId": "RetryExecuteWebhooks",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookEvent",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_ExecuteWebhook | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReports/{vesselReportNo}/webhooks/{webhookEvent}/webhook/{webhookNo}": {
"post": {
"tags": [
"VesselReports"
],
"summary": "Runs a specific webhook that is of type VesselReport and active.\r\nReturns a list of validation Results with results for all found webhooks.",
"operationId": "ExecuteSingleWebhook",
"parameters": [
{
"name": "vesselReportNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookEvent",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_ExecuteWebhook | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportScripts/calculate": {
"post": {
"tags": [
"VesselReportScripts"
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportScripts/validate": {
"post": {
"tags": [
"VesselReportScripts"
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportScripts/tree": {
"post": {
"tags": [
"VesselReportScripts"
],
"parameters": [
{
"name": "type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Updating.WebVesselReportingSystem.VesselReportScriptObjectType"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScriptNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScriptNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScriptNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportScripts/run": {
"post": {
"tags": [
"VesselReportScripts"
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances": {
"get": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Gets a list of VesselReportSequenceInstances",
"operationId": "GetVesselReportSequenceInstances",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Creates a new VesselReportSequenceInstance record",
"operationId": "CreateVesselReportSequenceInstance",
"requestBody": {
"description": "The VesselReportSequenceInstance Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances/{vesselReportSequenceInstanceNo}": {
"get": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Gets a specific VesselReportSequenceInstance",
"operationId": "GetVesselReportSequenceInstance",
"parameters": [
{
"name": "vesselReportSequenceInstanceNo",
"in": "path",
"description": "The VesselReportSequenceInstanceNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested sequence",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a sequence with the supplied sequence No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Updates an existing VesselReportSequenceInstance",
"operationId": "UpdateVesselReportSequenceInstance",
"parameters": [
{
"name": "vesselReportSequenceInstanceNo",
"in": "path",
"description": "The vesselReportSequenceInstanceNo of the vesselReportSequenceInstance to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The VesselReportSequenceInstance DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated vesselReportSequenceInstance object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Deletes a VesselReportSequenceInstance record",
"parameters": [
{
"name": "vesselReportSequenceInstanceNo",
"in": "path",
"description": "The vesselReportSequenceInstanceNo of the vesselReportSequenceInstance to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances/{vesselReportSequenceInstanceNo}/history": {
"get": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Gets history for a specific VesselReportSequenceInstance",
"operationId": "GetVesselReportSequenceInstanceHistory",
"parameters": [
{
"name": "vesselReportSequenceInstanceNo",
"in": "path",
"description": "The VesselReportSequenceInstanceNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested sequence",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a sequence with the supplied sequence No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances/search": {
"post": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Search for VesselReportSequenceInstance\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVesselReportSequenceInstances",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances/searchIndex/{VesselReportSequenceInstanceGuid}": {
"post": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Get index of a record in a search for sequences\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVesselReportSequenceInstances",
"parameters": [
{
"name": "vesselReportSequenceInstanceGuid",
"in": "path",
"description": "The VesselReportSequenceInstance to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances/searchCount": {
"post": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Returns number of hits in a search for Form Templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVesselReportSequenceInstances",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances/searchInfo": {
"get": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVesselReportSequenceInstances",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VesselReportSequenceInstances/{vesselReportSequenceInstanceNo}/copy": {
"get": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Copies an existing VesselReportSequenceInstance to a new object",
"operationId": "CopyVesselReportSequenceInstance",
"parameters": [
{
"name": "vesselReportSequenceInstanceNo",
"in": "path",
"description": "The vesselReportSequenceInstanceNo of the vesselReportSequenceInstance to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new vesselReportSequenceInstance object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances/{vesselReportSequenceInstanceNo}/middlereports": {
"get": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Get middle reports of an existing sequence instance.",
"operationId": "GetMiddleReports",
"parameters": [
{
"name": "vesselReportSequenceInstanceNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceVesselReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceVesselReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceVesselReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances/{vesselReportSequenceInstanceNo}/middlereporttypes": {
"get": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Get middle reports of an existing sequence instance.",
"operationId": "GetMiddleReportTypes",
"parameters": [
{
"name": "vesselReportSequenceInstanceNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceVesselReportType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceVesselReportType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceVesselReportType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsSequenceInstance | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances/merge": {
"post": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Merges all Reports in the End and Middle Sequence Instances into the Start Instance.",
"operationId": "MergeVesselReportSequenceInstances",
"requestBody": {
"description": "The object containing Start Report No. and End Report No.",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceMerge"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceMerge"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceMerge"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceMerge"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Merge | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequenceInstances/split": {
"post": {
"tags": [
"VesselReportSequenceInstances"
],
"summary": "Split Reports In Sequence Instances into new instances",
"operationId": "SplitVesselReportSequenceInstances",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceSplit"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceSplit"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceSplit"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceSplit"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Split | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequences": {
"get": {
"tags": [
"VesselReportSequences"
],
"summary": "Gets a list of VesselReportSequences",
"operationId": "GetVesselReportSequences",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VesselReportSequences"
],
"summary": "Creates a new VesselReportSequence record",
"operationId": "CreateVesselReportSequence",
"requestBody": {
"description": "The VesselReportSequence Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequences/{vesselReportSequenceNo}": {
"get": {
"tags": [
"VesselReportSequences"
],
"summary": "Gets a specific VesselReportSequence",
"operationId": "GetVesselReportSequence",
"parameters": [
{
"name": "vesselReportSequenceNo",
"in": "path",
"description": "The VesselReportSequenceNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested sequence",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a sequence with the supplied sequence No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VesselReportSequences"
],
"summary": "Updates an existing VesselReportSequence",
"operationId": "UpdateVesselReportSequence",
"parameters": [
{
"name": "vesselReportSequenceNo",
"in": "path",
"description": "The vesselReportSequenceNo of the vesselReportSequence to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The VesselReportSequence DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated vesselReportSequence object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VesselReportSequences"
],
"summary": "Deletes a VesselReportSequence record",
"parameters": [
{
"name": "vesselReportSequenceNo",
"in": "path",
"description": "The vesselReportSequenceNo of the vesselReportSequence to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequences/{vesselReportSequenceNo}/history": {
"get": {
"tags": [
"VesselReportSequences"
],
"summary": "Gets history for a specific VesselReportSequence",
"operationId": "GetVesselReportSequenceHistory",
"parameters": [
{
"name": "vesselReportSequenceNo",
"in": "path",
"description": "The VesselReportSequenceNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested sequence",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a sequence with the supplied sequence No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequences/search": {
"post": {
"tags": [
"VesselReportSequences"
],
"summary": "Search for VesselReportSequence\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVesselReportSequences",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequences/searchIndex/{VesselReportSequenceGuid}": {
"post": {
"tags": [
"VesselReportSequences"
],
"summary": "Get index of a record in a search for sequences\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVesselReportSequences",
"parameters": [
{
"name": "vesselReportSequenceGuid",
"in": "path",
"description": "The VesselReportSequence to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequences/searchCount": {
"post": {
"tags": [
"VesselReportSequences"
],
"summary": "Returns number of hits in a search for Form Templates\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVesselReportSequences",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequences/searchInfo": {
"get": {
"tags": [
"VesselReportSequences"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVesselReportSequences",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VesselReportSequences/{vesselReportSequenceNo}/copy": {
"get": {
"tags": [
"VesselReportSequences"
],
"summary": "Copies an existing VesselReportSequence to a new object",
"operationId": "CopyVesselReportSequence",
"parameters": [
{
"name": "vesselReportSequenceNo",
"in": "path",
"description": "The vesselReportSequenceNo of the vesselReportSequence to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new vesselReportSequence object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequences/{vesselReportSequenceNo}/vesseltypes": {
"get": {
"tags": [
"VesselReportSequences"
],
"summary": "Gets the Vessel Types for a specific Vessel Report Sequence",
"operationId": "GetVesselReportSequenceVesselTypes",
"parameters": [
{
"name": "vesselReportSequenceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Vessel Types",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceVesselType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceVesselType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceVesselType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Vessel Report Sequence with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSequences/{vesselReportSequenceNo}/vesselreporttypes": {
"get": {
"tags": [
"VesselReportSequences"
],
"summary": "Gets the Vessel Types for a specific Vessel Report Sequence",
"operationId": "GetVesselReportSequenceVesselReportTypes",
"parameters": [
{
"name": "vesselReportSequenceNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Vessel Types",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceVesselReportType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceVesselReportType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceVesselReportType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Vessel Report Sequence with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportSequence | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature": {
"get": {
"tags": [
"VesselReportSignature"
],
"summary": "Gets a list of VesselReportSignatures",
"operationId": "GetVesselReportsSignature",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VesselReportSignature"
],
"summary": "Creates a new document record",
"operationId": "CreateVesselReportSignature",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/{documentNo}": {
"get": {
"tags": [
"VesselReportSignature"
],
"summary": "Gets a specific VesselReportSignature",
"operationId": "GetVesselReportSignature",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VesselReportSignature"
],
"summary": "Updates an existing Document",
"operationId": "UpdateVesselReportSignature",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VesselReportSignature"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/searchIndex/{documentGuid}": {
"post": {
"tags": [
"VesselReportSignature"
],
"summary": "Get index of a record in a search for VesselReportSignature\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVesselReportsSignature",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/{documentNo}/history": {
"get": {
"tags": [
"VesselReportSignature"
],
"summary": "Gets history for a specific VesselReportSignature",
"operationId": "GetVesselReportSignatureHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/search": {
"post": {
"tags": [
"VesselReportSignature"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVesselReportsSignature",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/searchCount": {
"post": {
"tags": [
"VesselReportSignature"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVesselReportsSignature",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/searchInfo": {
"get": {
"tags": [
"VesselReportSignature"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVesselReportsSignature",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VesselReportSignature/{documentNo}/pdf": {
"get": {
"tags": [
"VesselReportSignature"
],
"summary": "",
"operationId": "GetVesselReportSignaturePdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/{documentNo}/file": {
"get": {
"tags": [
"VesselReportSignature"
],
"summary": "",
"operationId": "GetVesselReportSignatureFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VesselReportSignature"
],
"operationId": "AddVesselReportSignatureFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"VesselReportSignature"
],
"summary": "Get document pdf from guid",
"operationId": "GetVesselReportSignaturePdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"VesselReportSignature"
],
"summary": "Get document file from guid",
"operationId": "GetVesselReportSignatureFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/{documentNo}/checkout": {
"put": {
"tags": [
"VesselReportSignature"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutVesselReportSignatureFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportSignature/{documentNo}/checkin": {
"post": {
"tags": [
"VesselReportSignature"
],
"summary": "",
"operationId": "CheckinVesselReportSignatureFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReport_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTableRevisionCaches": {
"get": {
"tags": [
"VesselReportTableRevisionCaches"
],
"summary": "Gets a list of VesselReportTableRevisionCaches",
"operationId": "GetVesselReportTableRevisionCaches",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableRevisionCache"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableRevisionCache"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableRevisionCache"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTableRevisionCaches/{VesselReportTableRevisionCacheNo}": {
"get": {
"tags": [
"VesselReportTableRevisionCaches"
],
"summary": "Gets a specific VesselReportTableRevisionCache",
"operationId": "GetVesselReportTableRevisionCache",
"parameters": [
{
"name": "VesselReportTableRevisionCacheNo",
"in": "path",
"description": "the VesselReportTableRevisionCacheNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested VesselReportTableRevisionCache",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableRevisionCache"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableRevisionCache"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableRevisionCache"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an VesselReportTableRevisionCache with the supplied VesselReportTableRevisionCache No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTables": {
"get": {
"tags": [
"VesselReportTables"
],
"summary": "Gets a list of VesselReportTables",
"operationId": "GetVesselReportTables",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VesselReportTables"
],
"summary": "Creates a new vesselReportTable record",
"operationId": "CreateVesselReportTable",
"requestBody": {
"description": "The VesselReportTable Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTables/{vesselReportTableNo}": {
"get": {
"tags": [
"VesselReportTables"
],
"summary": "Gets a specific VesselReportTable",
"operationId": "GetVesselReportTable",
"parameters": [
{
"name": "vesselReportTableNo",
"in": "path",
"description": "the vesselReportTableNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested vesselReportTable",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an vesselReportTable with the supplied VesselReportTable No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VesselReportTables"
],
"summary": "Updates an existing VesselReportTable",
"operationId": "UpdateVesselReportTable",
"parameters": [
{
"name": "vesselReportTableNo",
"in": "path",
"description": "The vesselReportTableNo of the vesselReportTable to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The VesselReportTable DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated VesselReportTable object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VesselReportTables"
],
"summary": "Deletes an vesselReportTable record",
"parameters": [
{
"name": "vesselReportTableNo",
"in": "path",
"description": "The vesselReportTableNo of the VesselReportTable to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTables/{vesselReportTableNo}/history": {
"get": {
"tags": [
"VesselReportTables"
],
"summary": "Gets history for a specific VesselReportTable",
"operationId": "GetVesselReportTableHistory",
"parameters": [
{
"name": "vesselReportTableNo",
"in": "path",
"description": "The vesselReportTableNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested vesselReportTable",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an vesselReportTable with the supplied VesselReportTable No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTables/search": {
"post": {
"tags": [
"VesselReportTables"
],
"summary": "Search for vesselReportTables\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVesselReportTables",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTables/searchCount": {
"post": {
"tags": [
"VesselReportTables"
],
"summary": "Returns number of hits in a search for VesselReportTables\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVesselReportTables",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTables/searchIndex/{vesselReportTableGuid}": {
"post": {
"tags": [
"VesselReportTables"
],
"summary": "Get index of a record in a search for VesselReportTables\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVesselReportTables",
"parameters": [
{
"name": "vesselReportTableGuid",
"in": "path",
"description": "The vesselReportTable to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTables/searchInfo": {
"get": {
"tags": [
"VesselReportTables"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVesselReportTables",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VesselReportTables/{vesselReportTableNo}/copy": {
"get": {
"tags": [
"VesselReportTables"
],
"summary": "Copies an existing vesselReportTable to a new object",
"operationId": "CopyVesselReportTable",
"parameters": [
{
"name": "vesselReportTableNo",
"in": "path",
"description": "The VesselReportTableNo of the vesselReportTable to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new VesselReportTable object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTables/{vesselReportTableNo}/columns": {
"get": {
"tags": [
"VesselReportTables"
],
"operationId": "GetVesselReportTableColumns",
"parameters": [
{
"name": "vesselReportTableNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableColumn"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableColumn"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableColumn"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTables/{vesselReportTableNo}/consumptionmappings": {
"get": {
"tags": [
"VesselReportTables"
],
"summary": "GetVesselReportTableConsumptionMappings",
"operationId": "GetVesselReportTableConsumptionMappings",
"parameters": [
{
"name": "vesselReportTableNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableConsumptionMapping"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableConsumptionMapping"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableConsumptionMapping"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTable | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeFieldDefinitions/{vesselReportTypeNo}/{definitionId}/script/usage": {
"post": {
"tags": [
"VesselReportTypeFieldDefinitions"
],
"summary": "",
"operationId": "GetDefinitionScriptUsage",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "definitionId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns usage of the definition",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTypeFieldDefinitionScriptUsage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTypeFieldDefinitionScriptUsage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTypeFieldDefinitionScriptUsage"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Vessel Report Type with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeGroups": {
"get": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Gets a list of VesselReportTypeGroups",
"operationId": "GetVesselReportTypeGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Creates a new VesselReportTypeGroup record",
"operationId": "CreateVesselReportTypeGroup",
"requestBody": {
"description": "The VesselReportTypeGroup Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeGroups/{VesselReportTypeGroupNo}": {
"get": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Gets a specific VesselReportTypeGroup",
"operationId": "GetVesselReportTypeGroup",
"parameters": [
{
"name": "VesselReportTypeGroupNo",
"in": "path",
"description": "the VesselReportTypeGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested VesselReportTypeGroup",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an VesselReportTypeGroup with the supplied VesselReportTypeGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Updates an existing VesselReportTypeGroup",
"operationId": "UpdateVesselReportTypeGroup",
"parameters": [
{
"name": "VesselReportTypeGroupNo",
"in": "path",
"description": "The VesselReportTypeGroupNo of the VesselReportTypeGroup to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The VesselReportTypeGroup DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated VesselReportTypeGroup object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Deletes an VesselReportTypeGroup record",
"parameters": [
{
"name": "VesselReportTypeGroupNo",
"in": "path",
"description": "The VesselReportTypeGroupNo of the VesselReportTypeGroup to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeGroups/{VesselReportTypeGroupNo}/history": {
"get": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Gets history for a specific VesselReportTypeGroup",
"operationId": "GetVesselReportTypeGroupHistory",
"parameters": [
{
"name": "VesselReportTypeGroupNo",
"in": "path",
"description": "The VesselReportTypeGroupNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested VesselReportTypeGroup",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an VesselReportTypeGroup with the supplied VesselReportTypeGroup No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeGroups/search": {
"post": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Search for VesselReportTypeGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVesselReportTypeGroups",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeGroups/searchCount": {
"post": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Returns number of hits in a search for VesselReportTypeGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVesselReportTypeGroups",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeGroups/searchIndex/{VesselReportTypeGroupGuid}": {
"post": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Get index of a record in a search for VesselReportTypeGroups\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVesselReportTypeGroups",
"parameters": [
{
"name": "VesselReportTypeGroupGuid",
"in": "path",
"description": "The VesselReportTypeGroup to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeGroups/searchInfo": {
"get": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVesselReportTypeGroups",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VesselReportTypeGroups/{VesselReportTypeGroupNo}/copy": {
"get": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Copies an existing VesselReportTypeGroup to a new object",
"operationId": "CopyVesselReportTypeGroup",
"parameters": [
{
"name": "VesselReportTypeGroupNo",
"in": "path",
"description": "The VesselReportTypeGroupNo of the VesselReportTypeGroup to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new VesselReportTypeGroup object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeGroups/{VesselReportTypeGroupNo}/CombinedUserRoles": {
"get": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "",
"operationId": "GetVesselReportTypeGroupCombinedUserRoles",
"parameters": [
{
"name": "VesselReportTypeGroupNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroupCombinedUserRole"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroupCombinedUserRole"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroupCombinedUserRole"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportTypeGroup | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeGroups/GetVesselReportTypeGroupsAllowedActions": {
"get": {
"tags": [
"VesselReportTypeGroups"
],
"summary": "Get Allowed actions",
"operationId": "GetVesselReportTypeGroupsAllowedActions",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroupAllowedActions"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroupAllowedActions"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroupAllowedActions"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeRevisionCaches": {
"get": {
"tags": [
"VesselReportTypeRevisionCaches"
],
"summary": "Gets a list of VesselReportTypeRevisionCaches",
"operationId": "GetVesselReportTypeRevisionCaches",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeRevisionCache"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeRevisionCache"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeRevisionCache"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypeRevisionCaches/{vesselReportTypeRevisionCacheNo}": {
"get": {
"tags": [
"VesselReportTypeRevisionCaches"
],
"summary": "Gets a specific VesselReportTypeRevisionCache",
"operationId": "GetVesselReportTypeRevisionCache",
"parameters": [
{
"name": "vesselReportTypeRevisionCacheNo",
"in": "path",
"description": "the vesselReportTypeRevisionCacheNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested vesselReportTypeRevisionCache",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeRevisionCache"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeRevisionCache"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeRevisionCache"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an vesselReportTypeRevisionCache with the supplied VesselReportTypeRevisionCache No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes": {
"get": {
"tags": [
"VesselReportTypes"
],
"summary": "Gets a list of VesselReportTypes",
"operationId": "GetVesselReportTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VesselReportTypes"
],
"summary": "Creates a new vesselReportType record",
"operationId": "CreateVesselReportType",
"requestBody": {
"description": "The VesselReportType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/{vesselReportTypeNo}": {
"get": {
"tags": [
"VesselReportTypes"
],
"summary": "Gets a specific VesselReportType",
"operationId": "GetVesselReportType",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "the vesselReportTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested vesselReportType",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an vesselReportType with the supplied VesselReportType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VesselReportTypes"
],
"summary": "Updates an existing VesselReportType",
"operationId": "UpdateVesselReportType",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "The vesselReportTypeNo of the vesselReportType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The VesselReportType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated VesselReportType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VesselReportTypes"
],
"summary": "Deletes an vesselReportType record",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "The vesselReportTypeNo of the VesselReportType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/{vesselReportTypeNo}/history": {
"get": {
"tags": [
"VesselReportTypes"
],
"summary": "Gets history for a specific VesselReportType",
"operationId": "GetVesselReportTypeHistory",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "The vesselReportTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested vesselReportType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an vesselReportType with the supplied VesselReportType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/search": {
"post": {
"tags": [
"VesselReportTypes"
],
"summary": "Search for vesselReportTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVesselReportTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/searchCount": {
"post": {
"tags": [
"VesselReportTypes"
],
"summary": "Returns number of hits in a search for VesselReportTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVesselReportTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/searchIndex/{vesselReportTypeGuid}": {
"post": {
"tags": [
"VesselReportTypes"
],
"summary": "Get index of a record in a search for VesselReportTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVesselReportTypes",
"parameters": [
{
"name": "vesselReportTypeGuid",
"in": "path",
"description": "The vesselReportType to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/searchInfo": {
"get": {
"tags": [
"VesselReportTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVesselReportTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VesselReportTypes/{vesselReportTypeNo}/copy": {
"get": {
"tags": [
"VesselReportTypes"
],
"summary": "Copies an existing vesselReportType to a new object",
"operationId": "CopyVesselReportType",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "The VesselReportTypeNo of the vesselReportType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new VesselReportType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/{vesselReportTypeNo}/vesseltypes": {
"get": {
"tags": [
"VesselReportTypes"
],
"summary": "Gets the Vessel Types for a specific Vessel Report Type",
"operationId": "GetVesselReportTypeVesselTypes",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Vessel Types",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeVesselType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeVesselType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeVesselType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Vessel Report Type with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/{vesselReportTypeNo}/approvers": {
"get": {
"tags": [
"VesselReportTypes"
],
"summary": "Gets the Approvers for a specific Vessel Report Type",
"operationId": "GetVesselReportTypeApprovers",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Vessel Types",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeApprover"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeApprover"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeApprover"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Vessel Report Type with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/{vesselReportTypeNo}/confidentialities": {
"get": {
"tags": [
"VesselReportTypes"
],
"summary": "Gets the Confidentialitys for a specific Vessel Report Type",
"operationId": "GetVesselReportTypeConfidentialities",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Vessel Types",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Vessel Report Type with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/{vesselReportTypeNo}/fielddefinitions": {
"get": {
"tags": [
"VesselReportTypes"
],
"summary": "Gets the Field Definitions for a specific Vessel Report Type",
"operationId": "GetVesselReportTypeFieldDefinitions",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Vessel Types",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeFieldDefinition"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeFieldDefinition"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeFieldDefinition"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Vessel Report Type with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/{vesselReportTypeNo}/analyticsCustomTemplates": {
"get": {
"tags": [
"VesselReportTypes"
],
"summary": "Gets the analytics Custom Templates for a specific Vessel Report Type",
"operationId": "GetVesselReportTypeAnalyticsCustomTemplates",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested Vessel Types",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an Vessel Report Type with the supplied No. cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/analytics/{vesselReportTypeNo}": {
"post": {
"tags": [
"VesselReportTypes"
],
"summary": "Creates a custom analytics view for the Vessel Report Type",
"operationId": "CreateCustomAnalyticsView",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeAnalyticsCustomTemplate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeAnalyticsCustomTemplate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeAnalyticsCustomTemplate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeAnalyticsCustomTemplate"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VesselReportTypes"
],
"summary": "Updates a custom analytics view for the Vessel Report Type",
"operationId": "UpdateCustomAnalyticsView",
"parameters": [
{
"name": "vesselReportTypeNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/export": {
"post": {
"tags": [
"VesselReportTypes"
],
"operationId": "ExportVesselReportTypes",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeExportResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeExportResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeExportResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselReportTypes/import": {
"post": {
"tags": [
"VesselReportTypes"
],
"operationId": "ImportVesselReportTypes",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeExportResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeExportResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeExportResult"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeExportResult"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselReportType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselTypes": {
"get": {
"tags": [
"VesselTypes"
],
"summary": "Gets a list of VesselTypes",
"operationId": "GetVesselTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VesselTypes"
],
"summary": "Creates a new vesselType record",
"operationId": "CreateVesselType",
"requestBody": {
"description": "The VesselType Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselTypes/{vesselTypeNo}": {
"get": {
"tags": [
"VesselTypes"
],
"summary": "Gets a specific VesselType",
"operationId": "GetVesselType",
"parameters": [
{
"name": "vesselTypeNo",
"in": "path",
"description": "The VesselTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested vesselType",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an vesselType with the supplied VesselType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VesselTypes"
],
"summary": "Updates an existing VesselType",
"operationId": "UpdateVesselType",
"parameters": [
{
"name": "vesselTypeNo",
"in": "path",
"description": "The VesselTypeNo of the vesselType to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The VesselType DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated VesselType object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VesselTypes"
],
"summary": "Deletes a vesselType record",
"parameters": [
{
"name": "vesselTypeNo",
"in": "path",
"description": "The VesselTypeNo of the VesselType to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselType_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselTypes/{vesselTypeNo}/history": {
"get": {
"tags": [
"VesselTypes"
],
"summary": "Gets history for a specific VesselType",
"operationId": "GetVesselTypeHistory",
"parameters": [
{
"name": "vesselTypeNo",
"in": "path",
"description": "The VesselTypeNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested vesselType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an vesselType with the supplied VesselType No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselType_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselTypes/search": {
"post": {
"tags": [
"VesselTypes"
],
"summary": "Search for VesselTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVesselTypes",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested vesselType",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselTypes/searchIndex/{vesselTypeGuid}": {
"post": {
"tags": [
"VesselTypes"
],
"summary": "Get index of a record in a search for vesselTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVesselTypes",
"parameters": [
{
"name": "vesselTypeGuid",
"in": "path",
"description": "The vesselType to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselTypes/searchCount": {
"post": {
"tags": [
"VesselTypes"
],
"summary": "Returns number of hits in a search for VesselTypes\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVesselTypes",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VesselTypes/searchInfo": {
"get": {
"tags": [
"VesselTypes"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVesselTypes",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VesselTypes/{vesselTypeNo}/copy": {
"get": {
"tags": [
"VesselTypes"
],
"summary": "Copies an existing VesselType to a new object",
"operationId": "CopyVesselType",
"parameters": [
{
"name": "vesselTypeNo",
"in": "path",
"description": "The VesselTypeNo of the vesselType to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new VesselType object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.VesselType"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VesselType_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Gets a list of VoyageReports",
"operationId": "GetVoyageReports",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VoyageReports"
],
"summary": "Creates a new VoyageReport record",
"operationId": "CreateVoyageReport",
"requestBody": {
"description": "The VoyageReport Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{VoyageReportNo}": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Gets a specific VoyageReport",
"operationId": "GetVoyageReport",
"parameters": [
{
"name": "VoyageReportNo",
"in": "path",
"description": "The VoyageReportNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested VoyageReport",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an VoyageReport with the supplied VoyageReport No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VoyageReports"
],
"summary": "Updates an existing VoyageReport",
"operationId": "UpdateVoyageReport",
"parameters": [
{
"name": "VoyageReportNo",
"in": "path",
"description": "The VoyageReportNo of the VoyageReport to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The VoyageReport DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated VoyageReport object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VoyageReports"
],
"summary": "Deletes a VoyageReport record",
"parameters": [
{
"name": "VoyageReportNo",
"in": "path",
"description": "The VoyageReportNo of the VoyageReport to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{VoyageReportNo}/history": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Gets history for a specific VoyageReport",
"operationId": "GetVoyageReportHistory",
"parameters": [
{
"name": "VoyageReportNo",
"in": "path",
"description": "The VoyageReportNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested VoyageReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an VoyageReport with the supplied VoyageReport No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/search": {
"post": {
"tags": [
"VoyageReports"
],
"summary": "Search for VoyageReports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVoyageReports",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested VoyageReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/searchIndex/{VoyageReportGuid}": {
"post": {
"tags": [
"VoyageReports"
],
"summary": "Get index of a record in a search for VoyageReports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVoyageReports",
"parameters": [
{
"name": "VoyageReportGuid",
"in": "path",
"description": "The VoyageReport to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/searchCount": {
"post": {
"tags": [
"VoyageReports"
],
"summary": "Returns number of hits in a search for VoyageReports\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVoyageReports",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/searchInfo": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVoyageReports",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VoyageReports/{VoyageReportNo}/copy": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Copies an existing VoyageReport to a new object",
"operationId": "CopyVoyageReport",
"parameters": [
{
"name": "VoyageReportNo",
"in": "path",
"description": "The VoyageReportNo of the VoyageReport to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new VoyageReport object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReport"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/auxItems": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches all VoyageReportItemAUXs attached to the VoyageReport",
"operationId": "GetAuxItems",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportItemAUX for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the jobgroups for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportAuxItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportAuxItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportAuxItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/auxItems/{itemNo}": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches a specific VoyageReportItemAUX attached to the VoyageReport",
"operationId": "GetAuxItem",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportItemAUX for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNo",
"in": "path",
"description": "The itemNo no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageReportItemAUXs for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportAuxItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportAuxItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportAuxItem"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/meItems": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches all VoyageReportItemMEs attached to the VoyageReport",
"operationId": "GetMEItems",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportItemME for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageReportItemMEs for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportMEItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportMEItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportMEItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/meItems/{itemNo}": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches a specific VoyageReportItemME attached to the VoyageReport",
"operationId": "GetMEItem",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportItemME for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNo",
"in": "path",
"description": "The itemNo no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageReportItemMEs for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportMEItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportMEItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportMEItem"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/offHireItems": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches all VoyageReportItemOffHires attached to the VoyageReport",
"operationId": "GetOffHireItems",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportItemOffHire for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageReportItemOffHires for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportOffHireItem"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportOffHireItem"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportOffHireItem"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/offHireItems/{itemNo}": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches a specific VoyageReportItemOffHire attached to the VoyageReport",
"operationId": "GetOffHireItem",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportItemOffHire for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNo",
"in": "path",
"description": "The itemNo no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageReportItemOffHires for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportOffHireItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportOffHireItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportOffHireItem"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/boilerItems": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches all VoyageReportItemBoilers attached to the VoyageReport",
"operationId": "GetBoilerItems",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportItemBoiler for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageReportItemBoilers for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/boilerItems/{itemNo}": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches a specific VoyageReportItemBoiler attached to the VoyageReport",
"operationId": "GetBoilerItem",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportItemBoiler for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "itemNo",
"in": "path",
"description": "The itemNo no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageReportItemBoiler for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/cargoes": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches all VoyageReportcargoes attached to the VoyageReport",
"operationId": "GetVoyageReportCargoes",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportCargo for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the cargoes for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargo"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargo"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargo"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/cargoes/{releaseNo}": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches a specific VoyageReportCargo attached to the VoyageReport",
"operationId": "GetVoyageReportCargo",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportCargo for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "releaseNo",
"in": "path",
"description": "The releaseNo no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageReportCargo for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargo"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/cargoes/{releaseNo}/details": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches a specific VoyageReportCargo attached to the VoyageReport",
"operationId": "GetVoyageReportCargoDetails",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageReportCargo for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "releaseNo",
"in": "path",
"description": "The releaseNo no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageReportCargoDetails for the VoyageReportCargo",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargoDetail"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargoDetail"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargoDetail"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/voyageData": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches all VoyageData attached to the VoyageReport",
"operationId": "GetVoyageDataList",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageData for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageData for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageData"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageData"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageData"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VoyageReports/{voyageReportNo}/voyageData/{VoyageDataNo}": {
"get": {
"tags": [
"VoyageReports"
],
"summary": "Fetches a specific VoyageData attached to the VoyageReport",
"operationId": "GetVoyageData",
"parameters": [
{
"name": "voyageReportNo",
"in": "path",
"description": "The VoyageReportNo to fetch VoyageData for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "voyageDataNo",
"in": "path",
"description": "The voyageDataNo no to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the VoyageData for the VoyageReport",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VoyageReport2 | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiConfigurations": {
"get": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Gets a list of API configurations",
"operationId": "GetVrsApiConfigurations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Creates a new API configuration record",
"operationId": "CreateVrsApiConfiguration",
"requestBody": {
"description": "The API Configuration Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiConfiguration_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiConfigurations/{no}": {
"get": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Gets a specific API configuration",
"operationId": "GetVrsApiConfiguration",
"parameters": [
{
"name": "no",
"in": "path",
"description": "The no. of the configuration to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested form configuration",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form configuration with the supplied API Configuration No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Updates an existing API Configuration",
"operationId": "UpdateVrsApiConfiguration",
"parameters": [
{
"name": "no",
"in": "path",
"description": "The no of the form configuration to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The API Configuration DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated configuration object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiConfiguration_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Deletes an API configuration record",
"parameters": [
{
"name": "no",
"in": "path",
"description": "The no of the configuration to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiConfiguration_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiConfigurations/{no}/history": {
"get": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Gets history for a specific API configuration",
"operationId": "GetVrsApiConfigurationHistory",
"parameters": [
{
"name": "no",
"in": "path",
"description": "The no. of the configuration to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested configuration",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a configuration with the supplied API Configuration No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiConfiguration_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiConfigurations/search": {
"post": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Search for API configurations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVrsApiConfigurations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiConfigurations/searchIndex/{configurationGuid}": {
"post": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Get index of a record in a search for API Configurations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVrsApiConfigurations",
"parameters": [
{
"name": "configurationGuid",
"in": "path",
"description": "The configuration to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiConfigurations/searchCount": {
"post": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Returns number of hits in a search for API configuration\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVrsApiConfigurations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiConfiguration | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiConfigurations/searchInfo": {
"get": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVrsApiConfigurations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VrsApiConfigurations/{no}/copy": {
"get": {
"tags": [
"VrsApiConfigurations"
],
"summary": "Copies an existing API Configuration to a new object",
"operationId": "CopyVrsApiConfiguration",
"parameters": [
{
"name": "no",
"in": "path",
"description": "The no of the configuration to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new configuration object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiConfiguration_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiScripts": {
"get": {
"tags": [
"VrsApiScripts"
],
"summary": "Gets a list of API scripts",
"operationId": "GetVrsApiScripts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"VrsApiScripts"
],
"summary": "Creates a new API script record",
"operationId": "CreateVrsApiScript",
"requestBody": {
"description": "The API Script Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiScript_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiScripts/{no}": {
"get": {
"tags": [
"VrsApiScripts"
],
"summary": "Gets a specific API script",
"operationId": "GetVrsApiScript",
"parameters": [
{
"name": "no",
"in": "path",
"description": "The no. of the script to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested form script",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form script with the supplied API Script No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"VrsApiScripts"
],
"summary": "Updates an existing API Script",
"operationId": "UpdateVrsApiScript",
"parameters": [
{
"name": "no",
"in": "path",
"description": "The no of the form script to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The API Script DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated script object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiScript_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"VrsApiScripts"
],
"summary": "Deletes an API script record",
"parameters": [
{
"name": "no",
"in": "path",
"description": "The no of the script to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiScript_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiScripts/{no}/history": {
"get": {
"tags": [
"VrsApiScripts"
],
"summary": "Gets history for a specific API script",
"operationId": "GetVrsApiScriptHistory",
"parameters": [
{
"name": "no",
"in": "path",
"description": "The no. of the script to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested script",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a script with the supplied API Script No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiScript_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiScripts/search": {
"post": {
"tags": [
"VrsApiScripts"
],
"summary": "Search for API scripts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchVrsApiScripts",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiScripts/searchIndex/{scriptGuid}": {
"post": {
"tags": [
"VrsApiScripts"
],
"summary": "Get index of a record in a search for API Scripts\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexVrsApiScripts",
"parameters": [
{
"name": "scriptGuid",
"in": "path",
"description": "The script to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiScripts/searchCount": {
"post": {
"tags": [
"VrsApiScripts"
],
"summary": "Returns number of hits in a search for API script\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountVrsApiScripts",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/VrsApiScripts/searchInfo": {
"get": {
"tags": [
"VrsApiScripts"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoVrsApiScripts",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/VrsApiScripts/{no}/copy": {
"get": {
"tags": [
"VrsApiScripts"
],
"summary": "Copies an existing API Script to a new object",
"operationId": "CopyVrsApiScript",
"parameters": [
{
"name": "no",
"in": "path",
"description": "The no of the script to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new script object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| VrsApiScript_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Warehouses": {
"get": {
"tags": [
"Warehouses"
],
"summary": "Gets a list of Warehouses",
"operationId": "GetWarehouses",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Warehouses"
],
"summary": "Creates a new warehouse record",
"operationId": "CreateWarehouse",
"requestBody": {
"description": "The Warehouse Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Warehouse_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Warehouses/{warehouseNo}": {
"get": {
"tags": [
"Warehouses"
],
"summary": "Gets a specific Warehouse",
"operationId": "GetWarehouse",
"parameters": [
{
"name": "warehouseNo",
"in": "path",
"description": "The WarehouseNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested warehouse",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an warehouse with the supplied Warehouse No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Warehouses"
],
"summary": "Updates an existing Warehouse",
"operationId": "UpdateWarehouse",
"parameters": [
{
"name": "warehouseNo",
"in": "path",
"description": "The WarehouseNo of the warehouse to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Warehouse DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Warehouse object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Warehouse_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Warehouses"
],
"summary": "Deletes a warehouse record",
"parameters": [
{
"name": "warehouseNo",
"in": "path",
"description": "The WarehouseNo of the Warehouse to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Warehouse_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Warehouses/{warehouseNo}/history": {
"get": {
"tags": [
"Warehouses"
],
"summary": "Gets history for a specific Warehouse",
"operationId": "GetWarehouseHistory",
"parameters": [
{
"name": "warehouseNo",
"in": "path",
"description": "The WarehouseNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested warehouse",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an warehouse with the supplied Warehouse No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Warehouse_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Warehouses/searchIndex/{warehouseGuid}": {
"post": {
"tags": [
"Warehouses"
],
"summary": "Get index of a record in a search for warehouse\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexWarehouses",
"parameters": [
{
"name": "warehouseGuid",
"in": "path",
"description": "The warehouse to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Warehouses/search": {
"post": {
"tags": [
"Warehouses"
],
"summary": "Search for Warehouses\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchWarehouses",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested warehouse",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Warehouse | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Warehouses/searchCount": {
"post": {
"tags": [
"Warehouses"
],
"summary": "Returns number of hits in a search for Warehouses\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountWarehouses",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Warehouses/searchInfo": {
"get": {
"tags": [
"Warehouses"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoWarehouses",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Warehouses/{warehouseNo}/force": {
"delete": {
"tags": [
"Warehouses"
],
"summary": "Force deletes a warehouse record\r\nForce deleting records may cause existing records to contain invalid data, that needs adjustment before they can be saved",
"parameters": [
{
"name": "warehouseNo",
"in": "path",
"description": "The WarehouseNo of the Warehouse to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Warehouse_ForceDelete | ForceDelete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Warehouses/{warehouseNo}/copy": {
"get": {
"tags": [
"Warehouses"
],
"summary": "Copies an existing warehouse to a new object",
"operationId": "CopyWarehouse",
"parameters": [
{
"name": "warehouseNo",
"in": "path",
"description": "The warehouseNo of the warehouse to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new warehouse object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Warehouse_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Warehouses/appRequest": {
"post": {
"tags": [
"Warehouses"
],
"summary": "Get Warehouses for App\r\nReturns warehouses for all units included in the unitGuid IN search criteria\r\n \r\n\"criteria\":[\r\n {\r\n \"values\":[\r\n {...}\r\n ],\r\n \"field\":\"unitGuid\",\r\n \"operator\":\"In\"\r\n }\r\n],",
"operationId": "WarehouseAppRequest",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.Warehouse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Warehouse | View |
| JobApp | Function |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent": {
"get": {
"tags": [
"WebDashboardContent"
],
"summary": "Gets a list of WebDashboardContent",
"operationId": "GetWebDashboardContents",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"WebDashboardContent"
],
"summary": "Creates a new webDashboardContent record",
"operationId": "CreateWebDashboardContent",
"requestBody": {
"description": "The WebDashboardContent Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent/{webDashboardContentNo}": {
"get": {
"tags": [
"WebDashboardContent"
],
"summary": "Gets a specific WebDashboardContent",
"operationId": "GetWebDashboardContent",
"parameters": [
{
"name": "webDashboardContentNo",
"in": "path",
"description": "The WebDashboardContentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested webDashboardContent",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an webDashboardContent with the supplied WebDashboardContent No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"WebDashboardContent"
],
"summary": "Updates an existing WebDashboardContent",
"operationId": "UpdateWebDashboardContent",
"parameters": [
{
"name": "webDashboardContentNo",
"in": "path",
"description": "The WebDashboardContentNo of the webDashboardContent to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A WebDashboardContentRepository",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated WebDashboardContent object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"WebDashboardContent"
],
"summary": "Deletes a webDashboardContent record",
"parameters": [
{
"name": "webDashboardContentNo",
"in": "path",
"description": "The WebDashboardContentNo of the WebDashboardContent to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent/{webDashboardContentNo}/history": {
"get": {
"tags": [
"WebDashboardContent"
],
"summary": "Gets history for a specific WebDashboardContent",
"operationId": "GetWebDashboardContentHistory",
"parameters": [
{
"name": "webDashboardContentNo",
"in": "path",
"description": "The WebDashboardContentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested webDashboardContent",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an webDashboardContent with the supplied WebDashboardContent No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent/search": {
"post": {
"tags": [
"WebDashboardContent"
],
"summary": "Search for WebDashboardContent\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchWebDashboardContent",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent/searchCount": {
"post": {
"tags": [
"WebDashboardContent"
],
"summary": "Returns number of hits in a search for WebDashboardContent\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountWebDashboardContent",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent/searchIndex/{webDashboardContentGuid}": {
"post": {
"tags": [
"WebDashboardContent"
],
"summary": "Get index of a record in a search for WebDashboardContent\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexWebDashboardContent",
"parameters": [
{
"name": "webDashboardContentGuid",
"in": "path",
"description": "The item to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent/searchInfo": {
"get": {
"tags": [
"WebDashboardContent"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoWebDashboardContent",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/WebDashboardContent/{webDashboardContentNo}/copy": {
"get": {
"tags": [
"WebDashboardContent"
],
"summary": "Copies an existing webDashboardContent to a new object",
"operationId": "CopyWebDashboardContent",
"parameters": [
{
"name": "webDashboardContentNo",
"in": "path",
"description": "The webDashboardContentNo of the webDashboardContent to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new webDashboardContent object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardContent"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent/{webDashboardContentNo}/dataset": {
"get": {
"tags": [
"WebDashboardContent"
],
"summary": "Gets dataset for content",
"operationId": "GetDataSet",
"parameters": [
{
"name": "webDashboardContentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitList",
"in": "query",
"description": "FilterList of units separated by '|'",
"schema": {
"type": "string"
}
},
{
"name": "fromDate",
"in": "query",
"description": "Filter from date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "toDate",
"in": "query",
"description": "Filter to date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "objectId",
"in": "query",
"description": "Object ID for filtering",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": { }
},
"application/json": {
"schema": { }
},
"text/json": {
"schema": { }
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent/{webDashboardContentNo}/singlevalue": {
"get": {
"tags": [
"WebDashboardContent"
],
"summary": "Get single value for content",
"operationId": "GetSingleValue",
"parameters": [
{
"name": "webDashboardContentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitList",
"in": "query",
"description": "List of units separated by '|'",
"schema": {
"type": "string"
}
},
{
"name": "fromDate",
"in": "query",
"description": "Filter from date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "toDate",
"in": "query",
"description": "Filter to date",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "objectId",
"in": "query",
"description": "Object ID for filtering",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "number",
"format": "double",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "number",
"format": "double",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "number",
"format": "double",
"nullable": true
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent/{webDashboardContentNo}/powerbitoken": {
"get": {
"tags": [
"WebDashboardContent"
],
"summary": "Get PowerBI Token",
"operationId": "GetPowerBIToken",
"parameters": [
{
"name": "webDashboardContentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "number",
"format": "double",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "number",
"format": "double",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "number",
"format": "double",
"nullable": true
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardContent/{webDashboardContentNo}/usage": {
"get": {
"tags": [
"WebDashboardContent"
],
"summary": "",
"operationId": "GetWebDashboardContentUsages",
"parameters": [
{
"name": "webDashboardContentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebDashboardModels.WebDashboardContentUsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebDashboardModels.WebDashboardContentUsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebDashboardModels.WebDashboardContentUsageView"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardContent | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds": {
"get": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Gets a list of WebDashboardPageBackgrounds",
"operationId": "GetWebDashboardPageBackgrounds",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Creates a new document record",
"operationId": "CreateWebDashboardPageBackground",
"parameters": [
{
"name": "forceAutogenerateDocumentNo",
"in": "query",
"description": "Forces API to set an autogenerated DocumentNo",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The Document Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/{documentNo}": {
"get": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Gets a specific WebDashboardPageBackground",
"operationId": "GetWebDashboardPageBackground",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Updates an existing Document",
"operationId": "UpdateWebDashboardPageBackground",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the document to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Document DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated Document object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Deletes a document record",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/searchIndex/{documentGuid}": {
"post": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Get index of a record in a search for WebDashboardPageBackground\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexWebDashboardPageBackgrounds",
"parameters": [
{
"name": "documentGuid",
"in": "path",
"description": "The document to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/{documentNo}/history": {
"get": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Gets history for a specific WebDashboardPageBackground",
"operationId": "GetWebDashboardPageBackgroundHistory",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/search": {
"post": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchWebDashboardPageBackgrounds",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/searchCount": {
"post": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Returns number of hits in a search for Documents\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountWebDashboardPageBackgrounds",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/searchInfo": {
"get": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoWebDashboardPageBackgrounds",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/WebDashboardPageBackgrounds/{documentNo}/pdf": {
"get": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "",
"operationId": "GetWebDashboardPageBackgroundPdf",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/{documentNo}/file": {
"get": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "",
"operationId": "GetWebDashboardPageBackgroundFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileContentDisposition"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"WebDashboardPageBackgrounds"
],
"operationId": "AddWebDashboardPageBackgroundFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/{documentNo}/history/{documentGuid}/pdf": {
"get": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Get document pdf from guid",
"operationId": "GetWebDashboardPageBackgroundPdfGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document Guid to get the pdf for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/{documentNo}/history/{documentGuid}/file": {
"get": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Get document file from guid",
"operationId": "GetWebDashboardPageBackgroundFileGuid",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentGuid",
"in": "path",
"description": "The document guid",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "contentDisposition",
"in": "query",
"description": "Set to 'inline' to view file in browser",
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be converted to pdf",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the requested document report as pdf"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/{documentNo}/checkout": {
"put": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Checks out the document to the current user.\r\nWhen document is checked out, it is allowed to download and edit the file, to subsequent check it in later",
"operationId": "CheckoutWebDashboardPageBackgroundFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The Document No. to get file for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "If a document cannot be checked out",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the checked out file"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/{documentNo}/checkin": {
"post": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "",
"operationId": "CheckinWebDashboardPageBackgroundFile",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkinWithoutVersion",
"in": "query",
"description": "",
"schema": {
"type": "boolean"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "revisionRemark",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Choose the file to upload",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"File"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "If a document cannot be checked in",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "Returns the updated document"
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/{documentNo}/copy": {
"get": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Copies an existing Document to a new object",
"operationId": "CopyWebDashboardPageBackground",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo of the Document to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new Document object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPageBackgrounds/{documentNo}/usage": {
"get": {
"tags": [
"WebDashboardPageBackgrounds"
],
"summary": "Gets usages for a specific Document",
"operationId": "GetWebDashboardPageBackgroundsUsages",
"parameters": [
{
"name": "documentNo",
"in": "path",
"description": "The DocumentNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a document with the supplied Document No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Gets a list of WebDashboardPage",
"operationId": "GetWebDashboardPages",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"WebDashboardPages"
],
"summary": "Creates a new WebDashboardPage record",
"operationId": "CreateWebDashboardPage",
"requestBody": {
"description": "The WebDashboardPage Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/{webDashboardPageNo}": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Gets a specific WebDashboardPage",
"operationId": "GetWebDashboardPage",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "The WebDashboardPageNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested WebDashboardPage",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an WebDashboardPage with the supplied WebDashboardPage No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"WebDashboardPages"
],
"summary": "Updates an existing WebDashboardPage",
"operationId": "UpdateWebDashboardPage",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "The WebDashboardPageNo of the WebDashboardPage to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A WebDashboardPageRepository",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated WebDashboardPage object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"WebDashboardPages"
],
"summary": "Deletes a WebDashboardPage record",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "The WebDashboardPageNo of the WebDashboardPage to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/{webDashboardPageNo}/history": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Gets history for a specific WebDashboardPage",
"operationId": "GetWebDashboardPageHistory",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "The WebDashboardPageNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested WebDashboardPage",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an WebDashboardPage with the supplied WebDashboardPage No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/search": {
"post": {
"tags": [
"WebDashboardPages"
],
"summary": "Search for WebDashboardPage\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchWebDashboardPage",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/searchCount": {
"post": {
"tags": [
"WebDashboardPages"
],
"summary": "Returns number of hits in a search for WebDashboardPage\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountWebDashboardPage",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/searchIndex/{webDashboardPageGuid}": {
"post": {
"tags": [
"WebDashboardPages"
],
"summary": "Get index of a record in a search for WebDashboardPage\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexWebDashboardPage",
"parameters": [
{
"name": "WebDashboardPageGuid",
"in": "path",
"description": "The item to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/searchInfo": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoWebDashboardPage",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/WebDashboardPages/{webDashboardPageNo}/copy": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Copies an existing WebDashboardPage to a new object",
"operationId": "CopyWebDashboardPage",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "The WebDashboardPageNo of the WebDashboardPage to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new WebDashboardPage object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPage"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/{webDashboardPageNo}/units": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Fetches all Units attached to the Web Dashboard Page",
"operationId": "GetWebDashboardPageUnits",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "The webDashboardPageNo to fetch webDashboardPageUnits for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the units for the webDashboardPage",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageUnit"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageUnit"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageUnit"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/{webDashboardPageNo}/webdashboardcontents": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Fetches all Web Dashboard Content attached to the Web Dashboard Page",
"operationId": "GetWebDashboardPageWebDashboardContents",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageWebDashboardContent"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageWebDashboardContent"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageWebDashboardContent"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/{webDashboardPageNo}/usage": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "",
"operationId": "GetWebDashboardPageUsages",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebDashboardModels.WebDashboardPageUsageView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebDashboardModels.WebDashboardPageUsageView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebDashboardModels.WebDashboardPageUsageView"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/{webDashboardPageNo}/sharedlinks": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Get shared links for web dashboard page",
"operationId": "GetWebDashboardPageSharedLinks",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageSharedLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageSharedLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageSharedLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/{webDashboardPageNo}/sharedlink": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Generates and returns a public shared link for the dashboard page",
"operationId": "GetWebDashboardPageSharedLink",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/resolveSharedLink/{linkKey}": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Generates access token for web dashboard page shared link",
"operationId": "ResolveSharedLink",
"parameters": [
{
"name": "linkKey",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageAccessToken"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageAccessToken"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageAccessToken"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/WebDashboardPages/pageAccessToken/{webDashboardPageNo}": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "Generates access token for the web dashboard page",
"operationId": "GetPageAccessToken",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageAccessToken"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageAccessToken"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageAccessToken"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/pageAccessToken/{webDashboardPageNo}/{unitNo}": {
"get": {
"tags": [
"WebDashboardPages"
],
"operationId": "GetPageUnitAccessToken",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "unitNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageAccessToken"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageAccessToken"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageAccessToken"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboardPages/{webDashboardPageNo}/filters": {
"get": {
"tags": [
"WebDashboardPages"
],
"summary": "",
"operationId": "GetWebDashboardPageFilters",
"parameters": [
{
"name": "webDashboardPageNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageSharedLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageSharedLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageSharedLink"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards": {
"get": {
"tags": [
"WebDashboards"
],
"summary": "Gets a list of WebDashboard",
"operationId": "GetWebDashboards",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"WebDashboards"
],
"summary": "Creates a new webDashboard record",
"operationId": "CreateWebDashboard",
"requestBody": {
"description": "The WebDashboard Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboard_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/{webDashboardNo}": {
"get": {
"tags": [
"WebDashboards"
],
"summary": "Gets a specific WebDashboard",
"operationId": "GetWebDashboard",
"parameters": [
{
"name": "webDashboardNo",
"in": "path",
"description": "The WebDashboardNo to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested webDashboard",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an webDashboard with the supplied WebDashboard No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"WebDashboards"
],
"summary": "Updates an existing WebDashboard",
"operationId": "UpdateWebDashboard",
"parameters": [
{
"name": "webDashboardNo",
"in": "path",
"description": "The WebDashboardNo of the webDashboard to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A WebDashboardRepository",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated WebDashboard object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboard_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"WebDashboards"
],
"summary": "Deletes a webDashboard record",
"parameters": [
{
"name": "webDashboardNo",
"in": "path",
"description": "The WebDashboardNo of the WebDashboard to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboard_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/{webDashboardNo}/history": {
"get": {
"tags": [
"WebDashboards"
],
"summary": "Gets history for a specific WebDashboard",
"operationId": "GetWebDashboardHistory",
"parameters": [
{
"name": "webDashboardNo",
"in": "path",
"description": "The WebDashboardNo to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested webDashboard",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an webDashboard with the supplied WebDashboard No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboard_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/search": {
"post": {
"tags": [
"WebDashboards"
],
"summary": "Search for WebDashboard\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchWebDashboard",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/searchCount": {
"post": {
"tags": [
"WebDashboards"
],
"summary": "Returns number of hits in a search for WebDashboard\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountWebDashboard",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/searchIndex/{webDashboardGuid}": {
"post": {
"tags": [
"WebDashboards"
],
"summary": "Get index of a record in a search for WebDashboard\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexWebDashboard",
"parameters": [
{
"name": "webDashboardGuid",
"in": "path",
"description": "The webDashboardPage to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/searchInfo": {
"get": {
"tags": [
"WebDashboards"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoWebDashboard",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/WebDashboards/{webDashboardNo}/copy": {
"get": {
"tags": [
"WebDashboards"
],
"summary": "Copies an existing webDashboard to a new object",
"operationId": "CopyWebDashboard",
"parameters": [
{
"name": "webDashboardNo",
"in": "path",
"description": "The webDashboardNo of the webDashboard to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new webDashboard object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboard_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/{webDashboardNo}/WebDashboardPages": {
"get": {
"tags": [
"WebDashboards"
],
"summary": "Returns a list of WebDashboardPages used to perform the WebDashboard",
"operationId": "GetWebDashboardWebDashboardPages",
"parameters": [
{
"name": "webDashboardNo",
"in": "path",
"description": "The WebDashboardNo to fetch webDashboardPages for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the webDashboard",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/{webDashboardNo}/WebDashboardPages/{webDashboardPageNo}": {
"get": {
"tags": [
"WebDashboards"
],
"summary": "Returns a specific webDashboard WebDashboardPage",
"operationId": "GetWebDashboardWebDashboardPage",
"parameters": [
{
"name": "webDashboardNo",
"in": "path",
"description": "The WebDashboardNo",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webDashboardPageNo",
"in": "path",
"description": "The webDashboardPageNo to fetch",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the webDashboard",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage"
}
}
}
},
"404": {
"description": "If a webDashboard webDashboardPage with the supplied WebDashboardPageNo cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/{webDashboardNo}/CombinedUserRoles": {
"get": {
"tags": [
"WebDashboards"
],
"summary": "",
"operationId": "GetWebDashboardCombinedUserRoles",
"parameters": [
{
"name": "webDashboardNo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardCombinedUserRole"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardCombinedUserRole"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardCombinedUserRole"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/available": {
"get": {
"tags": [
"WebDashboards"
],
"summary": "Gets the dashboards available to the current user",
"operationId": "GetAvailableDashboards",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboard"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboard | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebDashboards/{webDashboardNo}/AvailableWebDashboardPages": {
"get": {
"tags": [
"WebDashboards"
],
"summary": "Returns a list of WebDashboardPages available to current user",
"operationId": "GetAvailableWebDashboardPages",
"parameters": [
{
"name": "webDashboardNo",
"in": "path",
"description": "The WebDashboardNo to fetch webDashboardPages for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the spare parts for the webDashboard",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| WebDashboardPage | View |
| TaskList | View |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/execute": {
"post": {
"tags": [
"Webhooks"
],
"operationId": "ExecuteWebhook",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.ApiWebhookExecuteResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.ApiWebhookExecuteResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.ApiWebhookExecuteResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Webhooks_ExecuteFromAPI | Function |
Customer must have one of these License values set| Key | Right |
|---|
| ProcurementFlowExternalSystem |
| WebhooksIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Gets a list of API webhooks",
"operationId": "Getwebhooks",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Webhooks"
],
"summary": "Creates a new API webhook record",
"operationId": "CreateWebhook",
"requestBody": {
"description": "The API Webhook Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Webhooks_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Gets a specific API webhook",
"operationId": "GetWebhook",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"description": "The no. of the webhook to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the requested form webhook",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a form webhook with the supplied API Webhook No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"Webhooks"
],
"summary": "Updates an existing API Webhook",
"operationId": "UpdateWebhook",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"description": "The no of the form webhook to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The API Webhook DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated webhook object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Webhooks_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"Webhooks"
],
"summary": "Deletes an API webhook record",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"description": "The no of the webhook to delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Webhooks_Delete | Delete |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/webhookschedules": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Gets Webhook Schedules for a specific API webhook",
"operationId": "GetWebhookSchedules",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookSchedule"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookSchedule"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookSchedule"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ScheduledWebhooks |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/webhookschedules/{webhookScheduleGuid}": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Gets a specific Webhook Schedule",
"operationId": "GetWebhookSchedule",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookScheduleGuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookSchedule"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookSchedule"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookSchedule"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| ScheduledWebhooks |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/history": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Gets history for a specific API webhook",
"operationId": "GetWebhookHistory",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"description": "The no. of the webhook to get",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested webhook",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a webhook with the supplied API Webhook No cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Webhooks_HistoryMode | HistoryMode |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/search": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Search for Models.Webhooks. webhooks\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchWebhooks",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/responses": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Gets a list of Webhook Responses.",
"operationId": "GetWebhookResponses",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"description": "The Webhook No. to fetch values for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"Webhooks"
],
"summary": "Add response.",
"operationId": "AddWebhookResponse",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"description": "The Webhook No. to fetch for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The WebhookResponse DTO to send",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Webhooks_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/responses/count": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Returns number of Webhook Responses.",
"operationId": "CountWebhookResponses",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"description": "The Webhook No.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/webhooklogs/search": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Search for Webhook Logs for a specific API webhook\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchWebhookWebhookLogs",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"description": "The no. of the webhook to get logs for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights
Customer must have one of these License values set| Key | Right |
|---|
| WebhooksIntegration |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/webhooklogs/searchCount": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Returns number of hits in a search for the Webhook's Webhook Logs.\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchWebhookWebhookLogsCount",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"description": "The no. of the webhook to get logs for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/searchIndex/{webhookGuid}": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Get index of a record in a search for API webhooks\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexWebhooks",
"parameters": [
{
"name": "webhookGuid",
"in": "path",
"description": "The webhook to get index for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/searchCount": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Returns number of hits in a search for API webhook\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountWebhooks",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/searchInfo": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoWebhooks",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
},
"/Webhooks/{webhookNo}/copy": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Copies an existing API Webhook to a new object",
"operationId": "CopyWebhook",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"description": "The no of the webhook to copy",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the new webhook object with properties from original",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.Webhook"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Webhooks_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/tree": {
"post": {
"tags": [
"Webhooks"
],
"parameters": [
{
"name": "type",
"in": "query",
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataObject"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookScriptNode"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookScriptNode"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookScriptNode"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Webhooks_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/validate": {
"post": {
"tags": [
"Webhooks"
],
"summary": "",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookScriptValidation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookScriptValidation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookScriptValidation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookScriptValidation"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookRunScriptResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookRunScriptResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookRunScriptResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights| Key | Right |
|---|
| Webhooks_Update | Update |
"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/documents": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Returns a list of Documents used on the Webhook",
"operationId": "GetWebhookDocuments",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the triggers for the job",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookDocument"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookDocument"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookDocument"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/webhookapis": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Returns a list of APIs used on the Webhook",
"operationId": "GetWebhookAPIs",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookApi"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookApi"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookApi"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/Webhooks/{webhookNo}/webhookapis/{webhookAPIGuid}": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Gets a specific Webhook API",
"operationId": "GetWebhookAPI",
"parameters": [
{
"name": "webhookNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhookAPIGuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookApi"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookApi"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookApi"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "Not Found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebTaskListConfigurations": {
"get": {
"tags": [
"WebTaskListConfigurations"
],
"summary": "Gets a list of WebTaskListConfigurations",
"operationId": "GetWebTaskListConfigurations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"post": {
"tags": [
"WebTaskListConfigurations"
],
"summary": "Creates a new webTaskListConfiguration record",
"operationId": "CreateWebTaskListConfiguration",
"requestBody": {
"description": "The WebTaskListConfiguration Object, including reference lists",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebTaskListConfigurations/{guid}": {
"get": {
"tags": [
"WebTaskListConfigurations"
],
"summary": "Gets a specific WebTaskListConfiguration",
"operationId": "GetWebTaskListConfiguration",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The WebTaskListConfigurationNo to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Returns the requested webTaskListConfiguration",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If an webTaskListConfiguration with the supplied Guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"put": {
"tags": [
"WebTaskListConfigurations"
],
"summary": "Updates an existing WebTaskListConfiguration",
"operationId": "UpdateWebTaskListConfiguration",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The guid of the webTaskListConfiguration to update",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The WebTaskListConfiguration DTO object with the fields to update",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated WebTaskListConfiguration object",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
}
},
"400": {
"description": "Returns a ValidationResult with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"delete": {
"tags": [
"WebTaskListConfigurations"
],
"summary": "Deletes a webTaskListConfiguration record",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The Guid of the WebTaskListConfiguration to delete",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebTaskListConfigurations/{guid}/history": {
"get": {
"tags": [
"WebTaskListConfigurations"
],
"summary": "Gets history for a specific WebTaskListConfiguration",
"operationId": "GetWebTaskListConfigurationHistory",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The WebTaskListConfiguration to get",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Returns the requested WebTaskListConfiguration",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
}
}
},
"400": {
"description": "Returns a validation result with information about the bad request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
}
}
},
"404": {
"description": "If a WebTaskListConfiguration with the supplied guid cannot be found"
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebTaskListConfigurations/searchIndex/{resourceNo}": {
"post": {
"tags": [
"WebTaskListConfigurations"
],
"summary": "Get index of a record in a search for gridlayout\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchIndexWebTaskListConfigurations",
"parameters": [
{
"name": "webTaskListConfigurationGuid",
"in": "query",
"description": "The webTaskListConfiguration to get index for",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "resourceNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebTaskListConfigurations/search": {
"post": {
"tags": [
"WebTaskListConfigurations"
],
"summary": "Search for WebTaskListConfigurations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchWebTaskListConfigurations",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Pagesize",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "Returns the requested webTaskListConfiguration",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration"
}
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebTaskListConfigurations/searchCount": {
"post": {
"tags": [
"WebTaskListConfigurations"
],
"summary": "Returns number of hits in a search for WebTaskListConfigurations\r\nTakes a SearchDefinition input, which can include filters and sorting.",
"operationId": "SearchCountWebTaskListConfigurations",
"requestBody": {
"description": "The search definition",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "If user is unauthorized"
},
"403": {
"description": "User must have one of these User Rights"
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/WebTaskListConfigurations/searchInfo": {
"get": {
"tags": [
"WebTaskListConfigurations"
],
"summary": "Returns structured information about what and how you can search for",
"operationId": "SearchInfoWebTaskListConfigurations",
"responses": {
"200": {
"description": "Returns a list of valid search fields",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo"
}
}
}
},
"500": {
"description": "The api has encountered an unhandled exception. See Sertica logs for details"
}
}
}
}
},
"components": {
"schemas": {
"Logihold.BusinessObjects.Apps.Models.ComponentAppObject": {
"type": "object",
"properties": {
"componentNo": {
"type": "string",
"nullable": true
},
"parentComponentNo": {
"type": "string",
"nullable": true
},
"gpsLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"gpsLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.DocumentLinkAppObject": {
"type": "object",
"properties": {
"parentGuid": {
"type": "string",
"format": "uuid"
},
"documentNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DocumentType"
},
"url": {
"type": "string",
"nullable": true
},
"canConvertToPdf": {
"type": "boolean"
},
"source": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ExternalDocmentationSource"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobAppObject": {
"type": "object",
"properties": {
"jobNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"internalRemarks": {
"type": "string",
"nullable": true
},
"latestJobHistoryRemark": {
"type": "string",
"nullable": true
},
"nextDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"componentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"componentNoStructure": {
"type": "string",
"nullable": true
},
"componentNameStructure": {
"type": "string",
"nullable": true
},
"componentGPSLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"componentGPSLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"jobHistory": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobHistoryAppObject"
},
"responsibleUserGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"responsibleUserNo": {
"type": "string",
"nullable": true
},
"responsibleUserName": {
"type": "string",
"nullable": true
},
"isMainJob": {
"type": "boolean"
},
"jobOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mainJobGuid": {
"type": "string",
"nullable": true
},
"jobSequenceIsNextJob": {
"type": "boolean"
},
"jobSequenceNextJobGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isPartOfJobSequence": {
"type": "boolean"
},
"componentBarricaded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.DocumentLinkAppObject"
},
"nullable": true
},
"managementSystemDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobManagementSystemDocumentAppObject"
},
"nullable": true
},
"reportedBy": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"jobTemplateGuid": {
"type": "string",
"format": "uuid"
},
"gpsLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"gpsLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"jobLists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobListAppObject"
},
"nullable": true
},
"jobFormTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobFormTemplateAppObject"
},
"nullable": true
},
"jobProcedures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobProcedureAppObject"
},
"nullable": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobItemAppObject"
},
"nullable": true
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobResourceAppObject"
},
"nullable": true
},
"jobGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobJobGroupAppObject"
},
"nullable": true
},
"expectedFaults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobExpectedFaultAppObject"
},
"nullable": true
},
"createdFromApp": {
"type": "boolean",
"nullable": true
},
"hasCounterTrigger": {
"type": "boolean",
"nullable": true
},
"defectJob": {
"type": "boolean",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobExpectedFaultAppObject": {
"type": "object",
"properties": {
"jobGuid": {
"type": "string",
"format": "uuid"
},
"expectedFaultGuid": {
"type": "string",
"format": "uuid"
},
"expectedFaultNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobFormTemplateAppObject": {
"type": "object",
"properties": {
"activation": {
"type": "boolean"
},
"completion": {
"type": "boolean"
},
"availableInApp": {
"type": "boolean"
},
"jobGuid": {
"type": "string",
"format": "uuid"
},
"jobNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"formTemplateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormTemplateFormEditor"
},
"formGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"formNo": {
"type": "string",
"nullable": true
},
"formSubject": {
"type": "string",
"nullable": true
},
"formStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormStatus"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobGroupFormTemplateAppObject": {
"type": "object",
"properties": {
"activation": {
"type": "boolean"
},
"completion": {
"type": "boolean"
},
"jobGroupGuid": {
"type": "string",
"format": "uuid"
},
"jobGroupNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobGroupName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobHistoryAppObject": {
"type": "object",
"properties": {
"jobGuid": {
"type": "string",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"jobTaskRemarks": {
"type": "string",
"nullable": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobHistoryItemAppObject"
},
"nullable": true
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobHistoryResourceAppObject"
},
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobHistoryResponseAppObject"
},
"nullable": true
},
"jobHistoryPictures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobHistoryPictureAppObject"
},
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobHistoryStatus"
},
"synced": {
"type": "boolean"
},
"nextDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"doneDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"counterReading": {
"type": "number",
"format": "double",
"nullable": true
},
"activatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"finalizedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobHistoryItemAppObject": {
"type": "object",
"properties": {
"jobHistoryGuid": {
"type": "string",
"format": "uuid"
},
"itemGuid": {
"type": "string",
"format": "uuid"
},
"warehouseGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"createdOnClient": {
"type": "boolean"
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"quantityFromStock": {
"type": "number",
"format": "double",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"locationNo": {
"type": "string",
"nullable": true
},
"locationName": {
"type": "string",
"nullable": true
},
"synced": {
"type": "boolean"
},
"apiQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobHistoryPictureAppObject": {
"type": "object",
"properties": {
"synced": {
"type": "boolean"
},
"parentGuid": {
"type": "string",
"format": "uuid"
},
"documentNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DocumentType"
},
"url": {
"type": "string",
"nullable": true
},
"canConvertToPdf": {
"type": "boolean"
},
"source": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ExternalDocmentationSource"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobHistoryResourceAppObject": {
"type": "object",
"properties": {
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"manhour": {
"type": "number",
"format": "double",
"nullable": true
},
"apiManhour": {
"type": "number",
"format": "double",
"nullable": true
},
"jobHistoryGuid": {
"type": "string",
"format": "uuid"
},
"resourceDoneDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdOnClient": {
"type": "boolean"
},
"isUser": {
"type": "boolean"
},
"synced": {
"type": "boolean"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobHistoryResponseAppObject": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"jobHistoryGuid": {
"type": "string",
"format": "uuid"
},
"createUserGuid": {
"type": "string",
"format": "uuid"
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdOnClient": {
"type": "boolean"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobItemAppObject": {
"type": "object",
"properties": {
"jobGuid": {
"type": "string",
"format": "uuid"
},
"itemGuid": {
"type": "string",
"format": "uuid"
},
"warehouseGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"sparePartStock": {
"type": "number",
"format": "double",
"nullable": true
},
"locationNo": {
"type": "string",
"nullable": true
},
"locationName": {
"type": "string",
"nullable": true
},
"expectedItem": {
"type": "boolean",
"nullable": true
},
"componentItem": {
"type": "boolean",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobJobGroupAppObject": {
"type": "object",
"properties": {
"jobGuid": {
"type": "string",
"format": "uuid"
},
"jobGroupGuid": {
"type": "string",
"format": "uuid"
},
"jobGroupNo": {
"type": "string",
"nullable": true
},
"jobGroupName": {
"type": "string",
"nullable": true
},
"itemUsageMandatoryOnJobHistory": {
"type": "boolean",
"nullable": true
},
"requireRemark": {
"type": "boolean"
},
"gracePeriod": {
"type": "integer",
"format": "int32"
},
"jobGroupFormTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.JobGroupFormTemplateAppObject"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobListAppObject": {
"type": "object",
"properties": {
"defaultSearch": {
"type": "boolean"
},
"defaultOnDevice": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobManagementSystemDocumentAppObject": {
"type": "object",
"properties": {
"managementSystemDocumentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"managementSystemDocumentNo": {
"type": "string",
"nullable": true
},
"managementSystemDocumentSubject": {
"type": "string",
"nullable": true
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"managementSystemTitle": {
"type": "string",
"nullable": true
},
"jobGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"includeInPreview": {
"type": "boolean",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobProcedureAppObject": {
"type": "object",
"properties": {
"procedureNo": {
"type": "string",
"nullable": true
},
"procedureName": {
"type": "string",
"nullable": true
},
"procedureText": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Apps.Models.DocumentLinkAppObject"
},
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.JobResourceAppObject": {
"type": "object",
"properties": {
"jobGuid": {
"type": "string",
"format": "uuid"
},
"resourceGuid": {
"type": "string",
"format": "uuid"
},
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"manHours": {
"type": "number",
"format": "double",
"nullable": true
},
"isUser": {
"type": "boolean"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Apps.Models.MeasurementHistoryAppObject": {
"type": "object",
"properties": {
"measurementGuid": {
"type": "string",
"format": "uuid"
},
"value": {
"type": "number",
"format": "double",
"nullable": true
},
"valueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"readingPeriod": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponent": {
"type": "object",
"properties": {
"componentNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"parentComponentNo": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"manufacturer": {
"type": "string",
"nullable": true
},
"manufacturerNo": {
"type": "string",
"nullable": true
},
"typeNo": {
"type": "string",
"nullable": true
},
"serialNo": {
"type": "string",
"nullable": true
},
"drawingNo": {
"type": "string",
"nullable": true
},
"classification": {
"type": "string",
"nullable": true
},
"technicalInfo": {
"type": "string",
"nullable": true
},
"locationNo": {
"type": "string",
"nullable": true
},
"installedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"criticalEquipment": {
"type": "boolean",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"estimatedLifetime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"systemNo": {
"type": "string",
"nullable": true
},
"purchaseYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createdYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"scrapYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"initialPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"priceYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"counterNo": {
"type": "string",
"nullable": true
},
"sectionNo": {
"type": "string",
"nullable": true
},
"gpsLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"gpsLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"componentTypeNo": {
"type": "string",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"customProperties": {
"nullable": true
},
"qrCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponentDocument": {
"type": "object",
"properties": {
"componentNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponentItem": {
"type": "object",
"properties": {
"componentNo": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetDocument": {
"type": "object",
"properties": {
"documentNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"issueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"fileModified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"customProperties": {
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetFrequencyType": {
"enum": [
"RunOnce",
"Daily",
"Weekly",
"Monthly",
"Yearly",
"Counter"
],
"type": "string"
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetItem": {
"type": "object",
"properties": {
"itemNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"certificate": {
"type": "boolean",
"nullable": true
},
"critical": {
"type": "boolean",
"nullable": true
},
"manufacturer": {
"type": "string",
"nullable": true
},
"manufacturerNo": {
"type": "string",
"nullable": true
},
"typeNo": {
"type": "string",
"nullable": true
},
"standardNo": {
"type": "string",
"nullable": true
},
"referenceNo": {
"type": "string",
"nullable": true
},
"referencePosNo": {
"type": "string",
"nullable": true
},
"drawingNo": {
"type": "string",
"nullable": true
},
"drawingPosNo": {
"type": "string",
"nullable": true
},
"classification": {
"type": "string",
"nullable": true
},
"dimension": {
"type": "string",
"nullable": true
},
"qrCode": {
"type": "string",
"nullable": true
},
"warehouseNo": {
"type": "string",
"nullable": true
},
"locationNo": {
"type": "string",
"nullable": true
},
"minimumStock": {
"type": "number",
"format": "double",
"nullable": true
},
"maximumStock": {
"type": "number",
"format": "double",
"nullable": true
},
"itemGroupNo": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierPartNo": {
"type": "string",
"nullable": true
},
"supplierPartDescription": {
"type": "string",
"nullable": true
},
"deliveryDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"customProperties": {
"nullable": true
},
"internalRemark": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetItemDocument": {
"type": "object",
"properties": {
"itemNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJob": {
"type": "object",
"properties": {
"jobNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"frequencyType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetFrequencyType"
},
"planningType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetPlanningType"
},
"frequency": {
"type": "number",
"format": "double",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"counterStart": {
"type": "number",
"format": "double",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"jobGroupNo": {
"type": "string",
"nullable": true
},
"isMainJob": {
"type": "boolean",
"nullable": true
},
"mainJobNo": {
"type": "string",
"nullable": true
},
"jobOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"gpsLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"gpsLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"responsibleUserNo": {
"type": "string",
"nullable": true
},
"priorityNo": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"resourceNo": {
"type": "string",
"nullable": true
},
"manhour": {
"type": "number",
"format": "double",
"nullable": true
},
"externalCosts": {
"type": "number",
"format": "double",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"activation": {
"type": "boolean",
"nullable": true
},
"completion": {
"type": "boolean",
"nullable": true
},
"customProperties": {
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJobDocument": {
"type": "object",
"properties": {
"jobNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJobItem": {
"type": "object",
"properties": {
"jobNo": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"estimatedUsage": {
"type": "number",
"format": "double",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetPlanningType": {
"enum": [
"Floating",
"Fixed"
],
"type": "string"
},
"Logihold.BusinessObjects.Licensing.LicenseValidationIssue": {
"type": "object",
"properties": {
"license": {
"type": "string",
"nullable": true
},
"value": {
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.Licensing.LicenseValidationResult": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"message": {
"type": "string",
"nullable": true
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Licensing.LicenseValidationIssue"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAffector": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid"
},
"dimensionNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
},
"availableOnInvoice": {
"type": "boolean",
"nullable": true
},
"availableOnPurchaseOrderHeader": {
"type": "boolean",
"nullable": true
},
"availableOnPurchaseOrderPosition": {
"type": "boolean",
"nullable": true
},
"availableOnRequisitionHeader": {
"type": "boolean",
"nullable": true
},
"availableOnRequisitionPosition": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAvailableValue": {
"type": "object",
"properties": {
"valueNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAvailableValues": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAvailableValue"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAvailableValue"
},
"nullable": true
},
"readOnly": {
"type": "boolean"
},
"mandatory": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionInfo": {
"type": "object",
"properties": {
"companyNo": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"usedDimensionsOnHeader": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionUsedDimension"
},
"nullable": true
},
"usedDimensionsOnPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionUsedDimension"
},
"nullable": true
},
"dimensionValues": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAvailableValue"
},
"nullable": true
},
"availableValues": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionAvailableValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionObjectType": {
"enum": [
"PurchaseOrder",
"PurchaseOrderPosition",
"Requisition",
"RequisitionPosition",
"Invoice"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Accounting.AccountingDimensionUsedDimension": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid"
},
"dimensionNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.AzureAD.AzureADInformation": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"nullable": true
},
"clientId": {
"type": "string",
"nullable": true
},
"attemptAutomaticLogin": {
"type": "boolean"
},
"logoutUserOnExit": {
"type": "boolean"
},
"useAzureAD": {
"type": "boolean"
},
"hasTenantId": {
"type": "boolean",
"readOnly": true
},
"hasClientId": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.BudgetModule.FinancialFollowupSummary+Mode": {
"enum": [
"Month",
"Year",
"Quarter"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole+CombinedType": {
"enum": [
"None",
"User",
"Role"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type": {
"enum": [
"User",
"Role"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.CustomProperties.PropertyDataType": {
"enum": [
"Unknown",
"Int",
"Decimal",
"String",
"DateTime",
"Bool",
"List",
"Date"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.DischargedProductView": {
"type": "object",
"properties": {
"sqlWhereClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGenerateSqlWhereClause`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.DischargedProduct, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"operationGuid": {
"type": "string",
"format": "uuid"
},
"operationNo": {
"type": "string",
"nullable": true
},
"productCategory": {
"type": "string",
"nullable": true
},
"estimatedAmountDischarged": {
"type": "number",
"format": "double",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"duration": {
"type": "integer",
"format": "int32",
"nullable": true
},
"environmentalItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.Views.GrbOperationEnvironmentalItemView"
},
"nullable": true
},
"idSeq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sqlCommandClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGenerateSqlCommand`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.DischargedProduct, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"confidentialityColumnClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGetConfidentialityColumnDefinition`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.DischargedProduct, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Distribution.UnitShipmentRequisitionView": {
"type": "object",
"properties": {
"requisitionUnitNo": {
"type": "string",
"nullable": true
},
"requisitionNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionStatus"
},
"workflow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionWorkflow"
},
"addressNo": {
"type": "string",
"nullable": true
},
"addressName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.Document2UsageView": {
"type": "object",
"properties": {
"objectNo": {
"type": "string",
"nullable": true
},
"objectName": {
"type": "string",
"nullable": true
},
"objectGuid": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.DocumentUsageObjectType"
},
"objectUnitNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.DocumentManagement.DocumentUsageObjectType": {
"enum": [
"Unknown",
"Job",
"JobHistory",
"Component",
"Procedure",
"AnalyticsReport",
"SparePart",
"PurchaseOrder",
"SerticaForm",
"LogbookEvent",
"ComponentMap",
"Certificate",
"WebDashboardContent",
"Requisition",
"RequestForQuote",
"FormTemplate",
"ImInvoice",
"OrbOperation",
"Receiver",
"GrbOperation",
"GrbOperationReceiver",
"OdsrbOperation",
"OdsrbOperationReceiver",
"BrbOperation",
"BrbOperationReceiver"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.DocumentNotificationDaysDirection": {
"enum": [
"Before",
"After"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat": {
"enum": [
"Unknown",
"Image",
"PDF",
"WordDocument",
"Link",
"AutoCad",
"Excel",
"PowerPoint",
"Email",
"Visio",
"Projects",
"Website",
"FormFields"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.BallastRecordbook.Enums.BrbReceiverVesselType": {
"enum": [
"Barge",
"Other",
"TankTruck",
"AshoreFacility"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.Enums.GarbageReceiverVesselType": {
"enum": [
"Barge",
"Ship",
"TankTruck",
"AshoreFacility"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.Views.GrbOperationEnvironmentalItemView": {
"type": "object",
"properties": {
"sqlWhereClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGenerateSqlWhereClause`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.GrbOperationEnvironmentalItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"grbOperationGuid": {
"type": "string",
"format": "uuid"
},
"unitsUsed": {
"type": "integer",
"format": "int32",
"nullable": true
},
"unitsLoaded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"unitsBefore": {
"type": "integer",
"format": "int32",
"nullable": true
},
"unitsAfter": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"environmentalItemNo": {
"type": "string",
"nullable": true
},
"environmentalItemName": {
"type": "string",
"nullable": true
},
"unitOfMeasure": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Views.EnvironmentalItemView+UnitOfMeasureEnum"
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"operationNo": {
"type": "string",
"nullable": true
},
"operationUnitNo": {
"type": "string",
"nullable": true
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationTypeName": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationStatus"
},
"idSeq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sqlCommandClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGenerateSqlCommand`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.GrbOperationEnvironmentalItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"confidentialityColumnClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGetConfidentialityColumnDefinition`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.GrbOperationEnvironmentalItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Enums.ReceiverType": {
"enum": [
"Sludge",
"Bilge",
"Bunkering",
"Ozone"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Enums.ReceiverVesselType": {
"enum": [
"Barge",
"Vessel",
"TankTruck",
"AshoreFacility",
"Other"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Models.ChangeOver": {
"enum": [
"EndedBeforeEntry",
"StartedAfterExit"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Models.SoundingTableData": {
"type": "object",
"properties": {
"ullage": {
"type": "boolean"
},
"columns": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"trims": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"limits": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "number",
"format": "float",
"nullable": true
},
"nullable": true
},
"nullable": true
},
"rows": {
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Views.EnvironmentalItemView+UnitOfMeasureEnum": {
"enum": [
"CubicMeters",
"Liters"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Views.SoundingView+SoundingTypeEnum": {
"enum": [
"Initial",
"Daily",
"Operation",
"Justification"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OzoneDepletingSubstancesRecordbook.Enums.InterventionDescriptionType": {
"enum": [
"LeakTest",
"RefrigerantAddition",
"RefrigerantDischarged"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OzoneDepletingSubstancesRecordbook.Enums.OdsrbReceiverVesselType": {
"enum": [
"Barge",
"Other",
"TankTruck",
"AshoreFacility"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.OperationGroupType": {
"enum": [
"ORB_I_A",
"ORB_I_B",
"ORB_I_C",
"ORB_I_D",
"ORB_I_E",
"ORB_I_F",
"ORB_I_G",
"ORB_I_H",
"ORB_I_I",
"ORB_I_ECP",
"ORB_I_CHAINS",
"ORB_I_PART_III",
"GRB_A",
"GRB_B",
"GRB_C",
"GRB_D",
"GRB_E",
"GRB_F",
"GRB_G",
"GRB_H",
"ECP_1",
"ECP_2",
"GRB_I",
"GRB_J",
"ODSRB_1",
"ODSRB_2",
"ODSRB_3",
"ODSRB_4",
"ODSRB_5",
"ODSRB_A",
"ODSRB_B",
"BRB_A",
"BRB_B",
"BRB_C",
"BRB_D",
"BRB_E",
"BRB_F",
"BRB_G",
"BRB_H"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.OperationTankConfigurationFilter": {
"type": "object",
"properties": {
"productClasses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookProductClass"
},
"nullable": true
},
"ioppTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookIOPPType"
},
"nullable": true
},
"withCompartments": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.LogbookNode": {
"type": "object",
"properties": {
"nodeType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationTypeConfigurationNodeType"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationBaseNode"
},
"nullable": true
},
"logbook": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
},
"group": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.OperationGroupType"
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationBaseNode": {
"type": "object",
"properties": {
"nodeType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationTypeConfigurationNodeType"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationBaseNode"
},
"nullable": true
},
"logbook": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
},
"group": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.OperationGroupType"
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationConfigurationTreeSearchDefintion": {
"type": "object",
"properties": {
"includeOperationTypeConfiguration": {
"type": "boolean"
},
"onlyIncludeOperationTypesConfigurationInUse": {
"type": "boolean"
},
"orbIPartIII": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OrbIPartIIISearch"
},
"excludedOperationTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationDefinition": {
"type": "object",
"properties": {
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"printoutType": {
"type": "string",
"nullable": true
},
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationSourceDestination"
},
"nullable": true
},
"destinations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationSourceDestination"
},
"nullable": true
},
"secondDestinations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationSourceDestination"
},
"nullable": true
},
"tankConfigurationsQuantity": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationDefintionQuantity"
},
"sourceTanksPerConfigurationsQuantity": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationDefintionQuantity"
},
"destinationTanksPerConfigurationsQuantity": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationDefintionQuantity"
},
"secondDestinationTanksPerConfigurationsQuantity": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationDefintionQuantity"
},
"sourceTankFilters": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.OperationTankConfigurationFilter"
},
"destinationTankFilters": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.OperationTankConfigurationFilter"
},
"secondDestinationTankFilters": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.OperationTankConfigurationFilter"
},
"predefinedTankOperationConfiguration": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.PredifinedTankOperationConfiguration"
},
"requiresIncinerator": {
"type": "boolean"
},
"requiresOws": {
"type": "boolean"
},
"requiresOrbIPartIIFlag": {
"type": "boolean",
"readOnly": true
},
"requiresBwmp": {
"type": "boolean"
},
"includeSealSubSealPointType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SealSubSealPointType"
},
"operationChain": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"nullable": true
},
"logbook": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
},
"group": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.OperationGroupType"
},
"isSourceGeneric": {
"type": "boolean",
"readOnly": true
},
"isDestinationGeneric": {
"type": "boolean",
"readOnly": true
},
"tankConfigurationsNeeded": {
"type": "boolean",
"readOnly": true
},
"isSourceCustom": {
"type": "boolean",
"readOnly": true
},
"isDestinationCustom": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationDefintionQuantity": {
"enum": [
"None",
"SingleAllowed",
"SingleRequired",
"MultipleAllowed",
"MultipleRequired"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationSourceDestination": {
"enum": [
"Tank",
"Custom",
"Sea",
"Ashore",
"Evaporation",
"Incinerator",
"Boiler",
"OilWaterSeparator",
"BilgeWells",
"ObservationTank",
"Other"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType": {
"enum": [
"ORB_I_A_1_1",
"ORB_I_A_1_2",
"ORB_I_A_1_3_1",
"ORB_I_A_1_3_2",
"ORB_I_A_1_4",
"ORB_I_A_1_5",
"ORB_I_A_3_A",
"ORB_I_A_3_B",
"ORB_I_A_4",
"ORB_I_B_2",
"ORB_I_B_2_A",
"ORB_I_B_3",
"ORB_I_B_9_1",
"ORB_I_B_9_2",
"ORB_I_C_3",
"ORB_I_C_4",
"ORB_I_C_4_A",
"ORB_I_C_11",
"ORB_I_C_11_4_A",
"ORB_I_C_11_4_B",
"ORB_I_C_11_4_C",
"ORB_I_C_11_4_D",
"ORB_I_C_11_4_E",
"ORB_I_C_11_A",
"ORB_I_C_11_B",
"ORB_I_C_12_1",
"ORB_I_C_12_2_A",
"ORB_I_C_12_2_B",
"ORB_I_C_12_2_C",
"ORB_I_C_12_3",
"ORB_I_C_12_4_A",
"ORB_I_C_12_4_B",
"ORB_I_C_12_4_C",
"ORB_I_C_12_4_D",
"ORB_I_C_12_4_E",
"ORB_I_D_5",
"ORB_I_D_15_1_A",
"ORB_I_D_15_1_B",
"ORB_I_D_15_1_C",
"ORB_I_D_15_2",
"ORB_I_D_15_3_A",
"ORB_I_D_15_3_B",
"ORB_I_D_15_3_C",
"ORB_I_D_15_3_F",
"ORB_I_D_15_3_G",
"ORB_I_D_15_3_H",
"ORB_I_D_15_3_I",
"ORB_I_D_15_3_J",
"ORB_I_E_16_A",
"ORB_I_E_16_B",
"ORB_I_E_17",
"ORB_I_E_A",
"ORB_I_F_A",
"ORB_I_F_B",
"ORB_I_F_C",
"ORB_I_F_D",
"ORB_I_G",
"ORB_I_H_26_A",
"ORB_I_H_26_B",
"ORB_I_I",
"ORB_I_I_A",
"ORB_I_I_B",
"ORB_I_I_D",
"ORB_I_I_E",
"ORB_I_I_F",
"ORB_I_I_H",
"ORB_I_I_J",
"ORB_I_I_K",
"ORB_I_I_L",
"ORB_I_I_M",
"ORB_I_I_N",
"ORB_I_I_P",
"ORB_I_I_Q",
"ORB_I_ECP_I_A",
"DAILY_SOUNDING",
"ORB_I_CHAIN_D_15_3_C_C_11_4_A",
"ORB_I_CHAIN_D_15_1_A_D_15_3_G",
"ORB_I_CHAIN_I_F_B_9_1_I_E",
"ORB_I_CHAIN_I_F_D_15_1_A_I_E",
"ORB_I_CHAIN_I_F_E_16_A_I_E",
"ORB_I_CHAIN_I_F_E_16_B_I_E",
"GRB_A",
"GRB_B",
"GRB_C",
"GRB_D",
"GRB_E",
"GRB_F",
"GRB_G",
"GRB_H",
"ECP_1",
"ECP_2",
"GRB_I",
"GRB_J",
"ODSRB_1",
"ODSRB_2",
"ODSRB_3_1",
"ODSRB_3_2",
"ODSRB_4",
"ODSRB_5",
"ODSRB_A",
"ODSRB_B",
"BRB_A_1",
"BRB_A_2",
"BRB_B_1",
"BRB_B_2",
"BRB_C_1",
"BRB_C_2",
"BRB_D_1",
"BRB_D_2",
"BRB_E_1",
"BRB_E_2",
"BRB_E_3",
"BRB_E_4",
"BRB_F_1",
"BRB_F_2",
"BRB_G_4",
"BRB_G_5",
"BRB_H",
"ERB_1"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationTypeConfigurationNodeType": {
"enum": [
"Logbook",
"OperationTypeConfigurationGroup",
"OperationTypeConfiguration",
"ChainOperationTypeConfiguration"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OrbIPartIIISearch": {
"enum": [
"Included",
"Excluded",
"Exclusively"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.PredifinedTankOperationConfiguration": {
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationSourceDestination"
},
"nullable": true
},
"destinations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationSourceDestination"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.FormTemplateTableColumnSetupJSON": {
"type": "object",
"properties": {
"columnNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"dataType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormTemplateTableColumnSetupDataType"
},
"mandatory": {
"type": "boolean"
},
"locked": {
"type": "boolean"
},
"dropdown": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ListOfValueTemplateJSON"
},
"tag": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WordFields"
},
"measurementNo": {
"type": "string",
"nullable": true
},
"dateFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DateTimeFormats"
},
"numericFormat": {
"type": "string",
"nullable": true
},
"measureUnit": {
"type": "string",
"nullable": true
},
"columnWidth": {
"type": "integer",
"format": "int32"
},
"dateMinValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateMaxValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"numericMinValue": {
"type": "number",
"format": "double",
"nullable": true
},
"numericMaxValue": {
"type": "number",
"format": "double",
"nullable": true
},
"sumColumn": {
"type": "boolean"
},
"skipThousandsSeparator": {
"type": "boolean",
"nullable": true
},
"default": {
"type": "string",
"nullable": true
},
"unitGuid": {
"type": "string",
"nullable": true
},
"latestHistoryGuid": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.FormTemplateTableJSON": {
"type": "object",
"properties": {
"formTemplateTableNo": {
"type": "string",
"nullable": true
},
"formTemplateTableName": {
"type": "string",
"nullable": true
},
"allowDeleteRows": {
"type": "boolean",
"nullable": true
},
"allowNewRows": {
"type": "boolean",
"nullable": true
},
"allowRowFilteringAndSorting": {
"type": "boolean",
"nullable": true
},
"tableRows": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.TemplateTableRowRender"
},
"nullable": true
},
"columnSetupList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.FormTemplateTableColumnSetupJSON"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Forms.FormUsageObjectType": {
"enum": [
"Unknown",
"Job",
"JobHistory"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Forms.FormUsageView": {
"type": "object",
"properties": {
"objectNo": {
"type": "string",
"nullable": true
},
"objectName": {
"type": "string",
"nullable": true
},
"objectGuid": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Forms.FormUsageObjectType"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.IPublishUnit": {
"type": "object",
"properties": {
"unitGuid": {
"type": "string",
"nullable": true,
"readOnly": true
},
"publish": {
"type": "boolean"
},
"unitNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"unitName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"draft": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApprovalFlowType": {
"enum": [
"ProcurementApprovalSetup",
"InvoiceApprovalFlow",
"CompanyUserApproval"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveArguments": {
"type": "object",
"properties": {
"decisions": {
"type": "object",
"properties": {
"AcceptMissingItemCertificates": {
"type": "boolean"
},
"AcceptInvoiceDifferences": {
"type": "boolean"
},
"MissingItemTypeContinueWithRemainingInvoices": {
"type": "boolean"
},
"AcceptPOAlreadyFullyInvoiced": {
"type": "boolean"
},
"ConfirmNextApproverUpdate": {
"type": "boolean"
},
"ApproveViaNextApproverUpdate": {
"type": "boolean"
},
"UpdateSupplierItemPrice": {
"type": "boolean"
},
"ContinueWithMultiSelect": {
"type": "boolean"
},
"UnitAccessContinueWithRemainingInvoices": {
"type": "boolean"
},
"ConfirmApproval": {
"type": "boolean"
}
},
"additionalProperties": false,
"nullable": true
},
"selections": {
"type": "object",
"properties": {
"CostType": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"nullable": true
},
"responseLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogData"
},
"nullable": true
},
"doNotCancelChanges": {
"type": "boolean"
},
"poStatusSelections": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceSetPOStatus"
},
"nullable": true
},
"perInvoiceCostTypeSelections": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveDecisionKey": {
"enum": [
"AcceptMissingItemCertificates",
"AcceptInvoiceDifferences",
"MissingItemTypeContinueWithRemainingInvoices",
"AcceptPOAlreadyFullyInvoiced",
"ConfirmNextApproverUpdate",
"ApproveViaNextApproverUpdate",
"UpdateSupplierItemPrice",
"ContinueWithMultiSelect",
"UnitAccessContinueWithRemainingInvoices",
"ConfirmApproval"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveDisplayMessage": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveMessageType"
},
"message": {
"type": "string",
"nullable": true
},
"affectedInvoices": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"isBlocking": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveInputContract": {
"type": "object",
"properties": {
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveRequiredDecision"
},
"nullable": true
},
"selections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveRequiredSelection"
},
"nullable": true
},
"invoiceResponseLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.InvoiceResponseLogRequirement"
},
"nullable": true
},
"poStatusSelections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.POStatusSelectionRequirement"
},
"nullable": true
},
"perInvoiceCostTypeSelections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.PerInvoiceCostTypeSelectionRequirement"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveInvoiceOperationResult": {
"type": "object",
"properties": {
"invoiceNo": {
"type": "string",
"nullable": true
},
"passedValidation": {
"type": "boolean"
},
"executedSuccessfully": {
"type": "boolean"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveDisplayMessage"
},
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveMessageType": {
"enum": [
"InvoiceWillBeSkipped",
"InvoiceSkippedMissingItemType",
"NotAuthorized",
"EmptyDimensions",
"MissingItemType",
"AlternatePayerNotAllowed",
"InvoiceSkippedNoUnitAccess",
"InvoiceSkippedInvalidPostingPeriod",
"InvoiceSkippedMissingCertificates",
"ApprovalResponsibleCannotApprove",
"NoNextApprover",
"NoneOfSelectedInvoicesCanBeApproved",
"ValidationFailed",
"ContractValidationFailed",
"ExecutionFailed",
"MultiSelectNotSupported"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveRequiredDecision": {
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveDecisionKey"
},
"question": {
"type": "string",
"nullable": true
},
"affectedInvoices": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"triggeredResponseLog": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogSpecification"
},
"isOptional": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveRequiredSelection": {
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveSelectionKey"
},
"requiresUserInput": {
"type": "boolean"
},
"availableOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.SelectionOption"
},
"nullable": true
},
"preselectedNo": {
"type": "string",
"nullable": true
},
"allowMultiple": {
"type": "boolean"
},
"hasPreselection": {
"type": "boolean",
"readOnly": true
},
"hasOptions": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveSelectionKey": {
"enum": [
"CostType"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalArguments": {
"type": "object",
"properties": {
"decisions": {
"type": "object",
"properties": {
"AcceptMissingItemCertificates": {
"type": "boolean"
},
"AcceptInvoiceDifferences": {
"type": "boolean"
},
"MissingItemTypeContinueWithRemainingInvoices": {
"type": "boolean"
}
},
"additionalProperties": false,
"nullable": true
},
"selections": {
"type": "object",
"properties": {
"ApprovalSetup": {
"type": "array",
"items": {
"type": "string"
}
},
"Approver": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"nullable": true
},
"responseLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogData"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalDecisionKey": {
"enum": [
"AcceptMissingItemCertificates",
"AcceptInvoiceDifferences",
"MissingItemTypeContinueWithRemainingInvoices"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalDisplayMessage": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalMessageType"
},
"message": {
"type": "string",
"nullable": true
},
"affectedInvoices": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"isBlocking": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalInputContract": {
"type": "object",
"properties": {
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalRequiredDecision"
},
"nullable": true
},
"selections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalRequiredSelection"
},
"nullable": true
},
"invoiceResponseLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.InvoiceResponseLogRequirement"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalMessageType": {
"enum": [
"InvoiceWillBeSkipped",
"InvoiceSkippedMissingPositionsWithPO",
"InvoiceSkippedMissingPositionsWithoutPO",
"InvoiceSkippedMissingItemType",
"NotAuthorized",
"EmptyDimensions",
"MissingItemType",
"AlternatePayerNotAllowed",
"ApproverNotFound",
"ValidationFailed",
"ContractValidationFailed",
"ExecutionFailed",
"MultiSelectNotSupported"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalRequiredDecision": {
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalDecisionKey"
},
"question": {
"type": "string",
"nullable": true
},
"affectedInvoices": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"triggeredResponseLog": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogSpecification"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalRequiredSelection": {
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalSelectionKey"
},
"promptText": {
"type": "string",
"nullable": true
},
"requiresUserInput": {
"type": "boolean"
},
"availableOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.SelectionOption"
},
"nullable": true
},
"preselectedNo": {
"type": "string",
"nullable": true
},
"allowMultiple": {
"type": "boolean"
},
"hasPreselection": {
"type": "boolean",
"readOnly": true
},
"hasOptions": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalSelectionKey": {
"enum": [
"ApprovalSetup",
"Approver"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceApproveResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"flowType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApprovalFlowType"
},
"displayInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveDisplayMessage"
},
"nullable": true
},
"requiredInput": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveInputContract"
},
"invoiceNo": {
"type": "string",
"nullable": true
},
"invoiceResults": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveInvoiceOperationResult"
},
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"hasBlockingErrors": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ImInvoiceForwardForApprovalResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"flowType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApprovalFlowType"
},
"displayInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalDisplayMessage"
},
"nullable": true
},
"requiredInput": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalInputContract"
},
"invoiceNo": {
"type": "string",
"nullable": true
},
"invoiceResults": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.InvoiceOperationResult"
},
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"hasBlockingErrors": {
"type": "boolean",
"readOnly": true
},
"requiresUserInput": {
"type": "boolean",
"readOnly": true
},
"canProceedToExecution": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.InvoiceOperationResult": {
"type": "object",
"properties": {
"invoiceNo": {
"type": "string",
"nullable": true
},
"passedValidation": {
"type": "boolean"
},
"executedSuccessfully": {
"type": "boolean"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalDisplayMessage"
},
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.InvoiceResponseLogRequirement": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogReason"
},
"appliedToInvoices": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"scope": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogScope"
},
"defaultMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.POStatusSelectionRequirement": {
"type": "object",
"properties": {
"invoicePurchaseOrderGuid": {
"type": "string",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"suggestedStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+InvoiceStatus"
},
"index": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"defaultMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.PerInvoiceCostTypeSelectionRequirement": {
"type": "object",
"properties": {
"invoiceNo": {
"type": "string",
"nullable": true
},
"requiresUserInput": {
"type": "boolean"
},
"preselectedCostTypeNo": {
"type": "string",
"nullable": true
},
"availableOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.SelectionOption"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.PreApproveArguments": {
"type": "object",
"properties": {
"decisions": {
"type": "object",
"properties": {
"AcceptInvoiceDifferences": {
"type": "boolean"
},
"ContinueWithMultiSelect": {
"type": "boolean"
},
"ConfirmPreApproval": {
"type": "boolean"
}
},
"additionalProperties": false,
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogData": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"recipientId": {
"type": "string",
"nullable": true
},
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogReason"
},
"invoiceNo": {
"type": "string",
"nullable": true
},
"dialogStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogStatus"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogReason": {
"enum": [
"MissingItemCertificates",
"CompanyPolicy"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogScope": {
"enum": [
"SharedAcrossInvoices",
"PerInvoice"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogSpecification": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogReason"
},
"scope": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogScope"
},
"appliedToInvoices": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"defaultMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ResponseLogStatus": {
"enum": [
"OK",
"Cancel"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.SelectionOption": {
"type": "object",
"properties": {
"no": {
"type": "string",
"nullable": true
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.JobNotificationDaysDirection": {
"enum": [
"Before",
"After"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ListOfValueTemplateJSON": {
"type": "object",
"properties": {
"listOfValuesTemplateNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"valueFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ListOfValueTemplateValuesJSON"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ListOfValueTemplateValuesJSON": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateIssueReason": {
"enum": [
"JobRelationsExistForComponent",
"PromptForRotateConfirmation",
"IsSubComponentError"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"readOnly": true
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.ComponentRotateIssue"
},
"nullable": true,
"readOnly": true
},
"refreshInSertica": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.CounterHistoryGraphData": {
"type": "object",
"properties": {
"trendPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.CounterHistoryGraphDataPoint"
},
"nullable": true,
"readOnly": true
},
"dataPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.CounterHistoryGraphDataPoint"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.CounterHistoryGraphDataPoint": {
"type": "object",
"properties": {
"idSeq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"valueDate": {
"type": "string",
"format": "date-time"
},
"value": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobMailAttachmentView": {
"type": "object",
"properties": {
"documentNo": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"sources": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestControlType": {
"enum": [
"Text",
"TextMultiline",
"Dropdown",
"Checkbox",
"Number",
"StaticText",
"Email",
"Image",
"Date"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestField": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestControlType"
},
"displayName": {
"type": "string",
"nullable": true
},
"propertyName": {
"type": "string",
"nullable": true
},
"required": {
"type": "boolean"
},
"listValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestListItem"
},
"nullable": true
},
"includeInSearch": {
"type": "boolean"
},
"showInSearchResults": {
"type": "boolean"
},
"jobField": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestJobField"
},
"row": {
"type": "integer",
"format": "int32",
"nullable": true
},
"skipThousandsSeparator": {
"type": "boolean",
"nullable": true
},
"numberOfDecimals": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minNumberValue": {
"type": "number",
"format": "double",
"nullable": true
},
"maxNumberValue": {
"type": "number",
"format": "double",
"nullable": true
},
"new": {
"type": "boolean"
},
"rejected": {
"type": "boolean"
},
"jobCreated": {
"type": "boolean"
},
"jobActivated": {
"type": "boolean"
},
"jobFinalized": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestJobField": {
"enum": [
"ComponentNo",
"JobText",
"JobName",
"JobGroupNo",
"ResourceNo"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestListItem": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"referenceNo": {
"type": "string",
"nullable": true
},
"sortOrder": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestStatus": {
"enum": [
"New",
"JobCreated",
"Rejected",
"JobActivated",
"JobFinalized"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplateJobRequestMailTemplateView": {
"type": "object",
"properties": {
"sqlWhereClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGenerateSqlWhereClause`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateJobRequestMailTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestStatus"
},
"jobRequestMailTemplateNo": {
"type": "string",
"nullable": true
},
"jobRequestTemplateGuid": {
"type": "string",
"format": "uuid"
},
"jobRequestTemplateNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"idSeq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sqlCommandClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGenerateSqlCommand`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateJobRequestMailTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"confidentialityColumnClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGetConfidentialityColumnDefinition`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateJobRequestMailTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplateNotificationUserView": {
"type": "object",
"properties": {
"sqlWhereClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGenerateSqlWhereClause`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateNotificationUser, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"jobRequestTemplateGuid": {
"type": "string",
"format": "uuid"
},
"jobRequestTemplateNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"idSeq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sqlCommandClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGenerateSqlCommand`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateNotificationUser, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"confidentialityColumnClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGetConfidentialityColumnDefinition`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateNotificationUser, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplateView": {
"type": "object",
"properties": {
"sqlWhereClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGenerateSqlWhereClause`1[[Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"jobRequestTemplateNo": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"submitButtonText": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestField"
},
"nullable": true
},
"logoDocumentNo": {
"type": "string",
"nullable": true
},
"logoDocumentDescription": {
"type": "string",
"nullable": true
},
"usersAsString": {
"type": "string",
"nullable": true
},
"userNamesAsString": {
"type": "string",
"nullable": true
},
"mailTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplateJobRequestMailTemplateView"
},
"nullable": true
},
"notificationUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplateNotificationUserView"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"idSeq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sqlCommandClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGenerateSqlCommand`1[[Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"confidentialityColumnClass": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.IGetConfidentialityColumnDefinition`1[[Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementHistoryGraphData": {
"type": "object",
"properties": {
"trendPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementHistoryGraphDataPoint"
},
"nullable": true,
"readOnly": true
},
"dataPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementHistoryGraphDataPoint"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementHistoryGraphDataPoint": {
"type": "object",
"properties": {
"idSeq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"valueDate": {
"type": "string",
"format": "date-time"
},
"value": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.MeasurementUsageView": {
"type": "object",
"properties": {
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobActivationIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobActivationIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobActivationIssueReason": {
"enum": [
"FixedTrigger",
"MissingActivationFormOnJob",
"RemarkFromLatestJobHistory",
"AlreadyActivated",
"NotFound",
"SubJob",
"AlreadyCompleted",
"FinancialDimensionsMissing"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDeactivationIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDeactivationIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDeactivationIssueReason": {
"enum": [
"NotFound",
"NotActivated",
"UsedInWeekReport",
"MainJob",
"NoOpenJobHistory",
"SubJob"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableArguments": {
"type": "object",
"properties": {
"relatedJobWarningAccepted": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableIssueReason": {
"enum": [
"NotAllowed",
"RelatedJobError",
"RelatedJobWarning"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobFinalizationIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobFinalizationIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobFinalizationIssueReason": {
"enum": [
"NotFound",
"NotActivated",
"NoOpenJobHistory",
"EquipmentHandlingResourcesStillAssigned",
"FixedTrigger",
"RelatedJobsNotFinalized",
"MissingFinalizeFormOnJob",
"MissingMainJob",
"JobHistoryBrokenRules",
"ItemUsageMandatory",
"RelatedJobDisabled",
"FilloutFaultCodesMandatory"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ManagementSystemPublisher+PublishableType": {
"enum": [
"Document",
"MainIndex",
"Section",
"RecordOfCorrection",
"FrontPage"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"readOnly": true
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResultIssue"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResultIssue"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResultIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResultIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ChangeRequestApproveResultIssueReason": {
"enum": [
"DocumentCouldNotBeValidated",
"ChangeRequestWithOlderRevisionWarning",
"UnitChangeMissingChangeOnUnit",
"DocumentHasOutstandingChangeRequests",
"IsDocNoStillUniquePerUnitIfStatusIsChangedTo",
"DocumentUsedOnJobError",
"ChangeToDraftDenied",
"ChangeToRequestedDenied",
"BypassApprovalDenied"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ManagementSystemManagementSystemPublishTaskView": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"managementSystemTitle": {
"type": "string",
"nullable": true
},
"publishTaskNo": {
"type": "string",
"nullable": true
},
"publishTaskStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ManagementSystemPublishTaskStatus"
},
"taskType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ManagementSystemPublishTaskTaskType"
},
"publishTaskArguments": {
"type": "string",
"nullable": true
},
"publishTaskProgressText": {
"type": "string",
"nullable": true
},
"publishTaskCreateUserNo": {
"type": "string",
"nullable": true
},
"publishTaskCreateUserName": {
"type": "string",
"nullable": true
},
"publishTaskCreateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"publishTaskUpdateUserNo": {
"type": "string",
"nullable": true
},
"publishTaskUpdateUserName": {
"type": "string",
"nullable": true
},
"publishTaskUpdateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"tsTaskNo": {
"type": "string",
"nullable": true
},
"tsTaskNextRunTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"tsTaskRunTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"tsTaskActivated": {
"type": "boolean",
"nullable": true
},
"tsTaskTaskStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TaskStatus"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ManagementSystemPublishTaskStatus": {
"enum": [
"Pending",
"InProgress",
"Published",
"Failed"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ManagementSystemPublishTaskTaskType": {
"enum": [
"Publish",
"UnitDeletion",
"IndexDocuments"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.PublishIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.PublishIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.PublishIssueReason": {
"enum": [
"DisplayUserAlreadyPublishing",
"DisplayPublishDeniedInfo",
"DisplayUnapprovedChangeRequestsWarning"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.PublishMode": {
"enum": [
"FirstPublish",
"ExportOnly",
"Denied"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.MasterDataManagementModels.MDMComponentInstanceView": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"nullable": true
},
"unitComponentInfo": {
"type": "string",
"nullable": true
},
"serialNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.MasterDataManagementTaskStatus": {
"enum": [
"Pending",
"Running",
"Completed",
"Error"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.MasterDataManagementTaskType": {
"enum": [
"UpdateUnits",
"CopyUnit"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount": {
"type": "object",
"properties": {
"value": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"rate": {
"type": "number",
"format": "double",
"nullable": true
},
"decimalPlaces": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.CalculatePOSaveResultIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.CalculatePOSaveResultIssueReason"
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.IssueType"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.CalculatePOSaveResultIssueReason": {
"enum": [
"NoOrdersCreated",
"MixedItemTypes",
"ValidatePositionsAgainstSupplier",
"CurrentUserNotAllowedToPurchase",
"PositionsMissingRequiredSFI",
"PositionsMissingRequiredItemType",
"PromptForRejectRemainingQuotes"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.CalculatePOTypes": {
"enum": [
"Requisition",
"RequestForQuote"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.IssueType": {
"enum": [
"Error",
"Warning"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.PurchaseOrderPositionPreview": {
"type": "object",
"properties": {
"positionNo": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"deliveryDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"originSparePartCatalogueSupplierGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitPrice": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"discount": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.PurchaseOrderPreview": {
"type": "object",
"properties": {
"originRFQGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"deliveryPlaceNo": {
"type": "string",
"nullable": true
},
"portCodeNo": {
"type": "string",
"nullable": true
},
"deliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"urgent": {
"type": "boolean",
"nullable": true
},
"deliveryDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"discount": {
"type": "number",
"format": "double",
"nullable": true
},
"isQuotedSupplier": {
"type": "boolean"
},
"supplierGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deliveryPlaceGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"currencyGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.PurchaseOrderPositionPreview"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.CombinePurchaseOrderPositionIssue": {
"type": "object",
"properties": {
"requisitionNo": {
"type": "string",
"nullable": true
},
"positionNo": {
"type": "integer",
"format": "int32"
},
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.CombinePurchaseOrderPositionIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.CombinePurchaseOrderPositionIssueReason": {
"enum": [
"PositionRejected",
"NotApprovedForOrder",
"UsedOnPurchaseOrder"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.ItemPriceHistory": {
"type": "object",
"properties": {
"price": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"orderDate": {
"type": "string",
"format": "date-time"
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"deliveryPlaceName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.ItemPurchaseOrderView": {
"type": "object",
"properties": {
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderDescription": {
"type": "string",
"nullable": true
},
"purchaseOrderStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderStatus"
},
"purchaseOrderWorkflow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderWorkflow"
},
"purchaseOrderUnitNo": {
"type": "string",
"nullable": true
},
"purchaseOrderUnitName": {
"type": "string",
"nullable": true
},
"purchaseOrderCreateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"orderDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"orderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PriceTrendIndicator": {
"enum": [
"Unchanged",
"Increasing",
"Decreasing"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderCreatorArguments": {
"type": "object",
"properties": {
"closeOpenRequestForQuotes": {
"type": "boolean",
"nullable": true
},
"rejectQuotesForOtherSuppliers": {
"type": "boolean",
"nullable": true
},
"forceCreate": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderMailAttachmentView": {
"type": "object",
"properties": {
"documentNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"sources": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerIssueReason": {
"enum": [
"NotAllowedOnUnit",
"UserMustApprove",
"ApprovalNotAllowed",
"WorkshopNotAllJobhistoriesFinalized",
"PlaceOrderWorkflowNotAllowed",
"NoPositions",
"OpenForChanges",
"MissingPlaceOrderRights",
"ApproverCannotPlaceOrder",
"NotSupoprted",
"UserIsNotAllowedToPurchase",
"ResendPurchaseOrderNeedAnswer",
"SendToSupplierArgumentsNeeded",
"NeedsGatekeeperReview",
"RequestedQuantiyIsDifferentThanSupplierQuantity",
"PlaceOrderPreconditionUnfulfilled"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"readOnly": true
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPlacerIssue"
},
"nullable": true,
"readOnly": true
},
"brokenRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.Rule"
},
"nullable": true,
"readOnly": true
},
"cancelled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPositionReception": {
"type": "object",
"properties": {
"positionNo": {
"type": "integer",
"format": "int32"
},
"internalRemark": {
"type": "string",
"nullable": true
},
"receivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"rejectedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"receivedQuantityDelta": {
"type": "number",
"format": "double",
"nullable": true
},
"rejectedQuantityDelta": {
"type": "number",
"format": "double",
"nullable": true
},
"rejectRemark": {
"type": "string",
"nullable": true
},
"rejectReasonNo": {
"type": "string",
"nullable": true
},
"rejectReasonName": {
"type": "string",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"orderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"deliveryNoteNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPriceApproverIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPriceApproverIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPriceApproverIssueReason": {
"enum": [
"PromptForFinancialImpactDialog",
"PromptForSelectApproverDialog",
"RequestedQuantiyIsDifferentThanSupplierQuantity",
"PromptForManualEmailNotification",
"PromptForPriceApproveConfirmation",
"PromptForUnacknowledgedResponseLogs",
"PromptForPriceApprovalSetup"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderReception": {
"type": "object",
"properties": {
"deliveryPortNo": {
"type": "string",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPositionReception"
},
"nullable": true
},
"acceptToReceiveMoreThanOrdered": {
"type": "boolean"
},
"sourceSystem": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderSendToSupplierArguments": {
"type": "object",
"properties": {
"forwardType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SupplierPurchaseOrderForwardType"
},
"address": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatePurchaseOrderIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatePurchaseOrderIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatePurchaseOrderIssueReason": {
"enum": [
"ValidatePositionsAgainstSupplier",
"AlreadyOrderedNotification",
"NoValidPositions",
"ContinueWithRemainingPositions",
"HasQuotesForOtherSuppliers",
"MissingUpdateUserRight"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatorArguments": {
"type": "object",
"properties": {
"requisitionNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"deliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"adviseBy": {
"type": "string",
"format": "date-time",
"nullable": true
},
"urgent": {
"type": "boolean",
"nullable": true
},
"supplierArguments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatorSupplierArguments"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatorSupplierArguments": {
"type": "object",
"properties": {
"supplierNo": {
"type": "string",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"deliveryPlaceNo": {
"type": "string",
"nullable": true
},
"deliveryPlaceToBeAdvised": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteMailAttachmentView": {
"type": "object",
"properties": {
"documentNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"sources": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteRequisitionView": {
"type": "object",
"properties": {
"requisitionUnitNo": {
"type": "string",
"nullable": true
},
"requisitionNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionStatus"
},
"workflow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionWorkflow"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteStatusChangeResultIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteStatusChangeResultIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteStatusChangeResultIssueReason": {
"enum": [
"ConfirmStatusChange",
"StatusChangeNotPossible"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionCountView": {
"type": "object",
"properties": {
"requisitionCount": {
"type": "integer",
"format": "int32"
},
"requisitionPositionCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionMailAttachmentView": {
"type": "object",
"properties": {
"documentNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"sources": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionRejectHandlerIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionRejectHandlerIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionRejectHandlerIssueReason": {
"enum": [
"UsedOnRFQ",
"UsedOnPO"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionCreatePurchaseOrderIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionCreatePurchaseOrderIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionCreatePurchaseOrderIssueReason": {
"enum": [
"MultiplePositionsWithSamePositionNo",
"MultiplePositionsWithSameSparepart",
"ValidatePositionsAgainstSupplier",
"NoValidPositions",
"ContinueWithRemainingPositions",
"HasOpenRequestForQuotes"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionPositionReception": {
"type": "object",
"properties": {
"positionNo": {
"type": "integer",
"format": "int32"
},
"internalRemark": {
"type": "string",
"nullable": true
},
"receivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"rejectedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"receivedQuantityDelta": {
"type": "number",
"format": "double",
"nullable": true
},
"rejectedQuantityDelta": {
"type": "number",
"format": "double",
"nullable": true
},
"rejectRemark": {
"type": "string",
"nullable": true
},
"rejectReasonNo": {
"type": "string",
"nullable": true
},
"rejectReasonName": {
"type": "string",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"orderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"deliveryNoteNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionReception": {
"type": "object",
"properties": {
"deliveryPortNo": {
"type": "string",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionPositionReception"
},
"nullable": true
},
"acceptToReceiveMoreThanOrdered": {
"type": "boolean"
},
"sourceSystem": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionRequestForQuoteView": {
"type": "object",
"properties": {
"requestForQuoteUnitNo": {
"type": "string",
"nullable": true
},
"requestForQuoteNo": {
"type": "string",
"nullable": true
},
"requestForQuoteStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequestForQuoteStatus"
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"requestForQuoteDateSent": {
"type": "string",
"format": "date-time",
"nullable": true
},
"requestForQuoteImportDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyDecimalPlaces": {
"type": "integer",
"format": "int32"
},
"totalPrice": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"totalPriceInStandardCurrency": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"standardCurrencyNo": {
"type": "string",
"nullable": true
},
"standardCurrencyDecimalPlaces": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.PurchaseTypeView+MandatoryOptionalEnum": {
"enum": [
"Disabled",
"Mandatory",
"Optional"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.DynamicGridColumnSetup": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true
},
"visible": {
"type": "boolean"
},
"width": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.DynamicGridSetup": {
"type": "object",
"properties": {
"containsSearchText": {
"type": "string",
"nullable": true
},
"containsSearchKeywords": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"orderBy": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy"
},
"columns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.DynamicGridColumnSetup"
},
"nullable": true
},
"filterStates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.GridFilterState"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest": {
"type": "object",
"properties": {
"deviceGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requestIdGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"fullSynchronization": {
"type": "boolean"
},
"appType": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.GridFilterState": {
"type": "object",
"properties": {
"searchDefinition": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition"
},
"searchInfoField": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfoField"
},
"parameters": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.LogicalOperator": {
"enum": [
"And",
"Or"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy": {
"type": "object",
"properties": {
"field": {
"type": "string",
"nullable": true
},
"direction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.View.SortDirection"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria": {
"type": "object",
"properties": {
"field": {
"type": "string",
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator"
},
"values": {
"type": "array",
"items": { },
"nullable": true
},
"valuesMatching": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.ValuesMatching"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDataType": {
"enum": [
"Unkonwn",
"String",
"Int",
"Decimal",
"Enum",
"DateTime",
"Guid",
"Bool",
"Duration"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition": {
"type": "object",
"properties": {
"distinct": {
"type": "boolean"
},
"subObjectsToInclude": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"contains": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"criteria": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria"
},
"nullable": true
},
"sorting": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy"
},
"nullable": true
},
"columns": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"forDeviceRequest": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest"
},
"unitFilter": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo": {
"type": "object",
"properties": {
"supportsContains": {
"type": "boolean"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfoField"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfoField": {
"type": "object",
"properties": {
"field": {
"type": "string",
"nullable": true
},
"dataType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDataType"
},
"operators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator"
},
"nullable": true
},
"enumType": {
"type": "string",
"nullable": true
},
"isCustomProperty": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator": {
"enum": [
"Equals",
"LessThan",
"GreaterThan",
"Like",
"Range",
"In",
"Dynamic",
"StartsWith",
"EndsWith",
"IsNull",
"NotLike",
"Or",
"NotEquals",
"NotIn"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.Search.ValuesMatching": {
"enum": [
"All",
"One"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.CounterFormInfo": {
"type": "object",
"properties": {
"counterNo": {
"type": "string",
"nullable": true
},
"counterGuid": {
"type": "string",
"nullable": true
},
"lastReadingValue": {
"type": "number",
"format": "double",
"nullable": true
},
"lastReadingDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"percentageAcceptableDeviation": {
"type": "number",
"format": "double",
"nullable": true
},
"maxEventsPerDay": {
"type": "number",
"format": "double",
"nullable": true
},
"counterMax": {
"type": "number",
"format": "double",
"nullable": true
},
"averageChangePerDay": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.FormFieldDocument": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid"
},
"description": {
"type": "string",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentFileName": {
"type": "string",
"nullable": true
},
"unitGuid": {
"type": "string",
"nullable": true,
"readOnly": true
},
"documentUnitNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"documentWebLink": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.SerticaFormField": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"nullable": true
},
"fieldType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FieldFormFieldsTypeColumnTypes"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mandatory": {
"type": "boolean",
"nullable": true
},
"timestamp": {
"type": "boolean",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateUserGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"caption": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"tag": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WordFields"
},
"default": {
"type": "string",
"nullable": true
},
"dateFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DateTimeFormats"
},
"numberFormat": {
"type": "string",
"nullable": true
},
"measureUnit": {
"type": "string",
"nullable": true
},
"measurementNo": {
"type": "string",
"nullable": true
},
"counterNo": {
"type": "string",
"nullable": true
},
"minNumberValue": {
"type": "number",
"format": "double",
"nullable": true
},
"maxNumberValue": {
"type": "number",
"format": "double",
"nullable": true
},
"minTextLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"maxTextLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"maxDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dynamicDateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DynamicDateType"
},
"dynamicDateOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"value": {
"nullable": true
},
"valueType": {
"type": "string",
"nullable": true
},
"column": {
"type": "integer",
"format": "int32",
"nullable": true
},
"row": {
"type": "integer",
"format": "int32",
"nullable": true
},
"page": {
"type": "integer",
"format": "int32",
"nullable": true
},
"listOfValueTemplateNo": {
"type": "string",
"nullable": true
},
"listOfValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.SerticaFormFieldListOfValue"
},
"nullable": true,
"readOnly": true
},
"formTemplateTableGuid": {
"type": "string",
"nullable": true
},
"isDateTimeTag": {
"type": "boolean",
"readOnly": true
},
"isNumberTag": {
"type": "boolean",
"readOnly": true
},
"formTemplateTableJSON": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.FormTemplateTableJSON"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.FormFieldDocument"
},
"nullable": true
},
"signature": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.FormFieldDocument"
},
"helpImage": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.FormFieldDocument"
},
"helpImageSize": {
"type": "integer",
"format": "int32",
"nullable": true
},
"columnSpan": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rowSpan": {
"type": "integer",
"format": "int32",
"nullable": true
},
"propertyName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.SerticaFormFieldListOfValue": {
"type": "object",
"properties": {
"key": {
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.SerticaFormObject": {
"type": "object",
"properties": {
"formTemplateGuid": {
"type": "string",
"format": "uuid"
},
"unitGuid": {
"type": "string",
"format": "uuid"
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"formTemplateHelpDescription": {
"type": "string",
"nullable": true
},
"pages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.SerticaFormPage"
},
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.SerticaFormField"
},
"nullable": true
},
"counterFormInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.CounterFormInfo"
},
"nullable": true
},
"isFormDuringApproval": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.SerticaFormPage": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.TemplateTableRowRender": {
"type": "object",
"properties": {
"mandatoryList": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"isSumRow": {
"type": "boolean"
},
"indexColumn": {
"type": "integer",
"format": "int32",
"nullable": true
},
"error": {
"type": "string",
"nullable": true,
"readOnly": true
},
"column0": {
"nullable": true
},
"columnCheckBox0": {
"type": "boolean",
"nullable": true
},
"columnDouble0": {
"type": "number",
"format": "double",
"nullable": true
},
"column1": {
"nullable": true
},
"columnCheckBox1": {
"type": "boolean",
"nullable": true
},
"columnDouble1": {
"type": "number",
"format": "double",
"nullable": true
},
"column2": {
"nullable": true
},
"columnCheckBox2": {
"type": "boolean",
"nullable": true
},
"columnDouble2": {
"type": "number",
"format": "double",
"nullable": true
},
"column3": {
"nullable": true
},
"columnCheckBox3": {
"type": "boolean",
"nullable": true
},
"columnDouble3": {
"type": "number",
"format": "double",
"nullable": true
},
"column4": {
"nullable": true
},
"columnCheckBox4": {
"type": "boolean",
"nullable": true
},
"columnDouble4": {
"type": "number",
"format": "double",
"nullable": true
},
"column5": {
"nullable": true
},
"columnCheckBox5": {
"type": "boolean",
"nullable": true
},
"columnDouble5": {
"type": "number",
"format": "double",
"nullable": true
},
"column6": {
"nullable": true
},
"columnCheckBox6": {
"type": "boolean",
"nullable": true
},
"columnDouble6": {
"type": "number",
"format": "double",
"nullable": true
},
"column7": {
"nullable": true
},
"columnCheckBox7": {
"type": "boolean",
"nullable": true
},
"columnDouble7": {
"type": "number",
"format": "double",
"nullable": true
},
"column8": {
"nullable": true
},
"columnCheckBox8": {
"type": "boolean",
"nullable": true
},
"columnDouble8": {
"type": "number",
"format": "double",
"nullable": true
},
"column9": {
"nullable": true
},
"columnCheckBox9": {
"type": "boolean",
"nullable": true
},
"columnDouble9": {
"type": "number",
"format": "double",
"nullable": true
},
"column10": {
"nullable": true
},
"columnCheckBox10": {
"type": "boolean",
"nullable": true
},
"columnDouble10": {
"type": "number",
"format": "double",
"nullable": true
},
"column11": {
"nullable": true
},
"columnCheckBox11": {
"type": "boolean",
"nullable": true
},
"columnDouble11": {
"type": "number",
"format": "double",
"nullable": true
},
"column12": {
"nullable": true
},
"columnCheckBox12": {
"type": "boolean",
"nullable": true
},
"columnDouble12": {
"type": "number",
"format": "double",
"nullable": true
},
"column13": {
"nullable": true
},
"columnCheckBox13": {
"type": "boolean",
"nullable": true
},
"columnDouble13": {
"type": "number",
"format": "double",
"nullable": true
},
"column14": {
"nullable": true
},
"columnCheckBox14": {
"type": "boolean",
"nullable": true
},
"columnDouble14": {
"type": "number",
"format": "double",
"nullable": true
},
"column15": {
"nullable": true
},
"columnCheckBox15": {
"type": "boolean",
"nullable": true
},
"columnDouble15": {
"type": "number",
"format": "double",
"nullable": true
},
"column16": {
"nullable": true
},
"columnCheckBox16": {
"type": "boolean",
"nullable": true
},
"columnDouble16": {
"type": "number",
"format": "double",
"nullable": true
},
"column17": {
"nullable": true
},
"columnCheckBox17": {
"type": "boolean",
"nullable": true
},
"columnDouble17": {
"type": "number",
"format": "double",
"nullable": true
},
"column18": {
"nullable": true
},
"columnCheckBox18": {
"type": "boolean",
"nullable": true
},
"columnDouble18": {
"type": "number",
"format": "double",
"nullable": true
},
"column19": {
"nullable": true
},
"columnCheckBox19": {
"type": "boolean",
"nullable": true
},
"columnDouble19": {
"type": "number",
"format": "double",
"nullable": true
},
"column20": {
"nullable": true
},
"columnCheckBox20": {
"type": "boolean",
"nullable": true
},
"columnDouble20": {
"type": "number",
"format": "double",
"nullable": true
},
"column21": {
"nullable": true
},
"columnCheckBox21": {
"type": "boolean",
"nullable": true
},
"columnDouble21": {
"type": "number",
"format": "double",
"nullable": true
},
"column22": {
"nullable": true
},
"columnCheckBox22": {
"type": "boolean",
"nullable": true
},
"columnDouble22": {
"type": "number",
"format": "double",
"nullable": true
},
"column23": {
"nullable": true
},
"columnCheckBox23": {
"type": "boolean",
"nullable": true
},
"columnDouble23": {
"type": "number",
"format": "double",
"nullable": true
},
"column24": {
"nullable": true
},
"columnCheckBox24": {
"type": "boolean",
"nullable": true
},
"columnDouble24": {
"type": "number",
"format": "double",
"nullable": true
},
"column25": {
"nullable": true
},
"columnCheckBox25": {
"type": "boolean",
"nullable": true
},
"columnDouble25": {
"type": "number",
"format": "double",
"nullable": true
},
"column26": {
"nullable": true
},
"columnCheckBox26": {
"type": "boolean",
"nullable": true
},
"columnDouble26": {
"type": "number",
"format": "double",
"nullable": true
},
"column27": {
"nullable": true
},
"columnCheckBox27": {
"type": "boolean",
"nullable": true
},
"columnDouble27": {
"type": "number",
"format": "double",
"nullable": true
},
"column28": {
"nullable": true
},
"columnCheckBox28": {
"type": "boolean",
"nullable": true
},
"columnDouble28": {
"type": "number",
"format": "double",
"nullable": true
},
"column29": {
"nullable": true
},
"columnCheckBox29": {
"type": "boolean",
"nullable": true
},
"columnDouble29": {
"type": "number",
"format": "double",
"nullable": true
},
"column30": {
"nullable": true
},
"columnCheckBox30": {
"type": "boolean",
"nullable": true
},
"columnDouble30": {
"type": "number",
"format": "double",
"nullable": true
},
"column31": {
"nullable": true
},
"columnCheckBox31": {
"type": "boolean",
"nullable": true
},
"columnDouble31": {
"type": "number",
"format": "double",
"nullable": true
},
"column32": {
"nullable": true
},
"columnCheckBox32": {
"type": "boolean",
"nullable": true
},
"columnDouble32": {
"type": "number",
"format": "double",
"nullable": true
},
"column33": {
"nullable": true
},
"columnCheckBox33": {
"type": "boolean",
"nullable": true
},
"columnDouble33": {
"type": "number",
"format": "double",
"nullable": true
},
"column34": {
"nullable": true
},
"columnCheckBox34": {
"type": "boolean",
"nullable": true
},
"columnDouble34": {
"type": "number",
"format": "double",
"nullable": true
},
"column35": {
"nullable": true
},
"columnCheckBox35": {
"type": "boolean",
"nullable": true
},
"columnDouble35": {
"type": "number",
"format": "double",
"nullable": true
},
"column36": {
"nullable": true
},
"columnCheckBox36": {
"type": "boolean",
"nullable": true
},
"columnDouble36": {
"type": "number",
"format": "double",
"nullable": true
},
"column37": {
"nullable": true
},
"columnCheckBox37": {
"type": "boolean",
"nullable": true
},
"columnDouble37": {
"type": "number",
"format": "double",
"nullable": true
},
"column38": {
"nullable": true
},
"columnCheckBox38": {
"type": "boolean",
"nullable": true
},
"columnDouble38": {
"type": "number",
"format": "double",
"nullable": true
},
"column39": {
"nullable": true
},
"columnCheckBox39": {
"type": "boolean",
"nullable": true
},
"columnDouble39": {
"type": "number",
"format": "double",
"nullable": true
},
"column40": {
"nullable": true
},
"columnCheckBox40": {
"type": "boolean",
"nullable": true
},
"columnDouble40": {
"type": "number",
"format": "double",
"nullable": true
},
"column41": {
"nullable": true
},
"columnCheckBox41": {
"type": "boolean",
"nullable": true
},
"columnDouble41": {
"type": "number",
"format": "double",
"nullable": true
},
"column42": {
"nullable": true
},
"columnCheckBox42": {
"type": "boolean",
"nullable": true
},
"columnDouble42": {
"type": "number",
"format": "double",
"nullable": true
},
"column43": {
"nullable": true
},
"columnCheckBox43": {
"type": "boolean",
"nullable": true
},
"columnDouble43": {
"type": "number",
"format": "double",
"nullable": true
},
"column44": {
"nullable": true
},
"columnCheckBox44": {
"type": "boolean",
"nullable": true
},
"columnDouble44": {
"type": "number",
"format": "double",
"nullable": true
},
"column45": {
"nullable": true
},
"columnCheckBox45": {
"type": "boolean",
"nullable": true
},
"columnDouble45": {
"type": "number",
"format": "double",
"nullable": true
},
"column46": {
"nullable": true
},
"columnCheckBox46": {
"type": "boolean",
"nullable": true
},
"columnDouble46": {
"type": "number",
"format": "double",
"nullable": true
},
"column47": {
"nullable": true
},
"columnCheckBox47": {
"type": "boolean",
"nullable": true
},
"columnDouble47": {
"type": "number",
"format": "double",
"nullable": true
},
"column48": {
"nullable": true
},
"columnCheckBox48": {
"type": "boolean",
"nullable": true
},
"columnDouble48": {
"type": "number",
"format": "double",
"nullable": true
},
"column49": {
"nullable": true
},
"columnCheckBox49": {
"type": "boolean",
"nullable": true
},
"columnDouble49": {
"type": "number",
"format": "double",
"nullable": true
},
"column50": {
"nullable": true
},
"columnCheckBox50": {
"type": "boolean",
"nullable": true
},
"columnDouble50": {
"type": "number",
"format": "double",
"nullable": true
},
"column51": {
"nullable": true
},
"columnCheckBox51": {
"type": "boolean",
"nullable": true
},
"columnDouble51": {
"type": "number",
"format": "double",
"nullable": true
},
"column52": {
"nullable": true
},
"columnCheckBox52": {
"type": "boolean",
"nullable": true
},
"columnDouble52": {
"type": "number",
"format": "double",
"nullable": true
},
"column53": {
"nullable": true
},
"columnCheckBox53": {
"type": "boolean",
"nullable": true
},
"columnDouble53": {
"type": "number",
"format": "double",
"nullable": true
},
"column54": {
"nullable": true
},
"columnCheckBox54": {
"type": "boolean",
"nullable": true
},
"columnDouble54": {
"type": "number",
"format": "double",
"nullable": true
},
"column55": {
"nullable": true
},
"columnCheckBox55": {
"type": "boolean",
"nullable": true
},
"columnDouble55": {
"type": "number",
"format": "double",
"nullable": true
},
"column56": {
"nullable": true
},
"columnCheckBox56": {
"type": "boolean",
"nullable": true
},
"columnDouble56": {
"type": "number",
"format": "double",
"nullable": true
},
"column57": {
"nullable": true
},
"columnCheckBox57": {
"type": "boolean",
"nullable": true
},
"columnDouble57": {
"type": "number",
"format": "double",
"nullable": true
},
"column58": {
"nullable": true
},
"columnCheckBox58": {
"type": "boolean",
"nullable": true
},
"columnDouble58": {
"type": "number",
"format": "double",
"nullable": true
},
"column59": {
"nullable": true
},
"columnCheckBox59": {
"type": "boolean",
"nullable": true
},
"columnDouble59": {
"type": "number",
"format": "double",
"nullable": true
},
"column60": {
"nullable": true
},
"columnCheckBox60": {
"type": "boolean",
"nullable": true
},
"columnDouble60": {
"type": "number",
"format": "double",
"nullable": true
},
"column61": {
"nullable": true
},
"columnCheckBox61": {
"type": "boolean",
"nullable": true
},
"columnDouble61": {
"type": "number",
"format": "double",
"nullable": true
},
"column62": {
"nullable": true
},
"columnCheckBox62": {
"type": "boolean",
"nullable": true
},
"columnDouble62": {
"type": "number",
"format": "double",
"nullable": true
},
"column63": {
"nullable": true
},
"columnCheckBox63": {
"type": "boolean",
"nullable": true
},
"columnDouble63": {
"type": "number",
"format": "double",
"nullable": true
},
"column64": {
"nullable": true
},
"columnCheckBox64": {
"type": "boolean",
"nullable": true
},
"columnDouble64": {
"type": "number",
"format": "double",
"nullable": true
},
"column65": {
"nullable": true
},
"columnCheckBox65": {
"type": "boolean",
"nullable": true
},
"columnDouble65": {
"type": "number",
"format": "double",
"nullable": true
},
"column66": {
"nullable": true
},
"columnCheckBox66": {
"type": "boolean",
"nullable": true
},
"columnDouble66": {
"type": "number",
"format": "double",
"nullable": true
},
"column67": {
"nullable": true
},
"columnCheckBox67": {
"type": "boolean",
"nullable": true
},
"columnDouble67": {
"type": "number",
"format": "double",
"nullable": true
},
"column68": {
"nullable": true
},
"columnCheckBox68": {
"type": "boolean",
"nullable": true
},
"columnDouble68": {
"type": "number",
"format": "double",
"nullable": true
},
"column69": {
"nullable": true
},
"columnCheckBox69": {
"type": "boolean",
"nullable": true
},
"columnDouble69": {
"type": "number",
"format": "double",
"nullable": true
},
"column70": {
"nullable": true
},
"columnCheckBox70": {
"type": "boolean",
"nullable": true
},
"columnDouble70": {
"type": "number",
"format": "double",
"nullable": true
},
"column71": {
"nullable": true
},
"columnCheckBox71": {
"type": "boolean",
"nullable": true
},
"columnDouble71": {
"type": "number",
"format": "double",
"nullable": true
},
"column72": {
"nullable": true
},
"columnCheckBox72": {
"type": "boolean",
"nullable": true
},
"columnDouble72": {
"type": "number",
"format": "double",
"nullable": true
},
"column73": {
"nullable": true
},
"columnCheckBox73": {
"type": "boolean",
"nullable": true
},
"columnDouble73": {
"type": "number",
"format": "double",
"nullable": true
},
"column74": {
"nullable": true
},
"columnCheckBox74": {
"type": "boolean",
"nullable": true
},
"columnDouble74": {
"type": "number",
"format": "double",
"nullable": true
},
"column75": {
"nullable": true
},
"columnCheckBox75": {
"type": "boolean",
"nullable": true
},
"columnDouble75": {
"type": "number",
"format": "double",
"nullable": true
},
"column76": {
"nullable": true
},
"columnCheckBox76": {
"type": "boolean",
"nullable": true
},
"columnDouble76": {
"type": "number",
"format": "double",
"nullable": true
},
"column77": {
"nullable": true
},
"columnCheckBox77": {
"type": "boolean",
"nullable": true
},
"columnDouble77": {
"type": "number",
"format": "double",
"nullable": true
},
"column78": {
"nullable": true
},
"columnCheckBox78": {
"type": "boolean",
"nullable": true
},
"columnDouble78": {
"type": "number",
"format": "double",
"nullable": true
},
"column79": {
"nullable": true
},
"columnCheckBox79": {
"type": "boolean",
"nullable": true
},
"columnDouble79": {
"type": "number",
"format": "double",
"nullable": true
},
"column80": {
"nullable": true
},
"columnCheckBox80": {
"type": "boolean",
"nullable": true
},
"columnDouble80": {
"type": "number",
"format": "double",
"nullable": true
},
"column81": {
"nullable": true
},
"columnCheckBox81": {
"type": "boolean",
"nullable": true
},
"columnDouble81": {
"type": "number",
"format": "double",
"nullable": true
},
"column82": {
"nullable": true
},
"columnCheckBox82": {
"type": "boolean",
"nullable": true
},
"columnDouble82": {
"type": "number",
"format": "double",
"nullable": true
},
"column83": {
"nullable": true
},
"columnCheckBox83": {
"type": "boolean",
"nullable": true
},
"columnDouble83": {
"type": "number",
"format": "double",
"nullable": true
},
"column84": {
"nullable": true
},
"columnCheckBox84": {
"type": "boolean",
"nullable": true
},
"columnDouble84": {
"type": "number",
"format": "double",
"nullable": true
},
"column85": {
"nullable": true
},
"columnCheckBox85": {
"type": "boolean",
"nullable": true
},
"columnDouble85": {
"type": "number",
"format": "double",
"nullable": true
},
"column86": {
"nullable": true
},
"columnCheckBox86": {
"type": "boolean",
"nullable": true
},
"columnDouble86": {
"type": "number",
"format": "double",
"nullable": true
},
"column87": {
"nullable": true
},
"columnCheckBox87": {
"type": "boolean",
"nullable": true
},
"columnDouble87": {
"type": "number",
"format": "double",
"nullable": true
},
"column88": {
"nullable": true
},
"columnCheckBox88": {
"type": "boolean",
"nullable": true
},
"columnDouble88": {
"type": "number",
"format": "double",
"nullable": true
},
"column89": {
"nullable": true
},
"columnCheckBox89": {
"type": "boolean",
"nullable": true
},
"columnDouble89": {
"type": "number",
"format": "double",
"nullable": true
},
"column90": {
"nullable": true
},
"columnCheckBox90": {
"type": "boolean",
"nullable": true
},
"columnDouble90": {
"type": "number",
"format": "double",
"nullable": true
},
"column91": {
"nullable": true
},
"columnCheckBox91": {
"type": "boolean",
"nullable": true
},
"columnDouble91": {
"type": "number",
"format": "double",
"nullable": true
},
"column92": {
"nullable": true
},
"columnCheckBox92": {
"type": "boolean",
"nullable": true
},
"columnDouble92": {
"type": "number",
"format": "double",
"nullable": true
},
"column93": {
"nullable": true
},
"columnCheckBox93": {
"type": "boolean",
"nullable": true
},
"columnDouble93": {
"type": "number",
"format": "double",
"nullable": true
},
"column94": {
"nullable": true
},
"columnCheckBox94": {
"type": "boolean",
"nullable": true
},
"columnDouble94": {
"type": "number",
"format": "double",
"nullable": true
},
"column95": {
"nullable": true
},
"columnCheckBox95": {
"type": "boolean",
"nullable": true
},
"columnDouble95": {
"type": "number",
"format": "double",
"nullable": true
},
"column96": {
"nullable": true
},
"columnCheckBox96": {
"type": "boolean",
"nullable": true
},
"columnDouble96": {
"type": "number",
"format": "double",
"nullable": true
},
"column97": {
"nullable": true
},
"columnCheckBox97": {
"type": "boolean",
"nullable": true
},
"columnDouble97": {
"type": "number",
"format": "double",
"nullable": true
},
"column98": {
"nullable": true
},
"columnCheckBox98": {
"type": "boolean",
"nullable": true
},
"columnDouble98": {
"type": "number",
"format": "double",
"nullable": true
},
"column99": {
"nullable": true
},
"columnCheckBox99": {
"type": "boolean",
"nullable": true
},
"columnDouble99": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.StationDescription": {
"enum": [
"StatusReset",
"BookingRequested",
"UnitPreliminaryBooked",
"UnitBooked",
"BookingCancelled",
"UnitClearedByCustoms",
"UnitUnloadedFromVessel",
"EquipmentInFromRepair",
"EquipmentOutForRepair",
"EquipmentAtPort",
"UnitCheckedIn",
"UnitLoadedOntoVessel",
"UnitReceivedAtTerminalGate",
"UnitReleasedFromTerminalGate",
"ShortShipped",
"UnitUnloadedFromTrain",
"UnitUnloadedFromBarge",
"UnitLoadedOntoTrain",
"ChangeOnPreliminaryBooked",
"ChangeOnBooked"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+AccountLayout": {
"enum": [
"Clipper",
"A2SEA",
"Epr",
"Axis",
"Svitzer",
"AccountSFI",
"CORO_AS",
"TORM",
"Visma",
"Echebastar",
"JL",
"DBB",
"ClassSFIOnPositions",
"NineDimensions",
"AccountingDimensions"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+AddressAvailable": {
"enum": [
"AllUnits",
"ListOfUnits",
"OfficeOnly"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+AddressClassificationAction": {
"enum": [
"None",
"Warning",
"Block"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+AnalyticsTemplateAvailableTo": {
"enum": [
"ListOfResourcesOrRoles",
"All"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ApprovalSetupDimensionType": {
"enum": [
"Project",
"Department",
"PurchaseType",
"TechnicalAccount"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+AuthenticationType": {
"enum": [
"None",
"Basic",
"APIToken",
"Custom"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+AutomaticReminderType": {
"enum": [
"RequestForQuoteNotConfirmed",
"PurchaseOrderNotConfirmed",
"DeliveryDateExceeded",
"InvoicedButNotReceived"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource": {
"enum": [
"All",
"ListOfUnits",
"None"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+BudgetModuleApproverStatus": {
"enum": [
"Open",
"AwaitingApproval",
"Approved",
"Rejected",
"ApprovalNotNeeded"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+CarrierPositionType": {
"enum": [
"CarrierPosition",
"CarrierPurchaseOrderPosition"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+CarrierStatus": {
"enum": [
"OnHand",
"PreparedForShipment",
"Picked",
"Shipped",
"Received"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule": {
"enum": [
"Optional",
"Mandatory",
"Disabled"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleVerificationType": {
"enum": [
"Verification",
"Annual",
"Intermediate",
"Periodical",
"Expire"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateStatus": {
"enum": [
"Valid",
"Obsolete",
"Pending"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ChangeRequestCause": {
"enum": [
"New",
"Changed",
"PhasedOut"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ChangeRequestStatus": {
"enum": [
"Draft",
"Requested",
"Accepted",
"Rejected",
"Published"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ChangeRequestType": {
"enum": [
"Change",
"Delete",
"UnitChange"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ClassAvailable": {
"enum": [
"AllUnits",
"ListOfUnits",
"OfficeOnly",
"OfficeOnlyListOfUnits"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+CompanyApprovalType": {
"enum": [
"ClassOrSFI",
"ItemType",
"AccountingDimension"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ComponentSortOrder": {
"enum": [
"Alphabetical",
"BySortOrder"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ControlledCopyType": {
"enum": [
"Print",
"PDF",
"Email"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataObject": {
"enum": [
"Invoice",
"AccrualExport",
"Currency",
"AnalyticsSubscription",
"ImInvoiceExport",
"InvoiceInfo",
"PurchaseOrder",
"PunchOut",
"Schedule",
"VesselReport",
"SyncItemExport",
"Requisition",
"PunchoutPurchaseOrder",
"SparePart",
"Job",
"API",
"Component",
"JobHistory",
"Unit",
"ExternalCalendar",
"Shipment"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataWarehouseConnectionType": {
"enum": [
"Normal",
"Limited",
"ReadOnly"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataWarehouseDataPersistence": {
"enum": [
"Overwrite",
"Append"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataWarehouseExportFrequencyRecurrence": {
"enum": [
"Months",
"Days",
"Hours"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+DateTimeFormats": {
"enum": [
"YYYYMMDD",
"YYYYMMDDHHMM",
"YYYYMMDDHHMMSS",
"DDMMYYY",
"DDMMYYYHHMM",
"DDMMYYYHHMMSS",
"LocalizationDate",
"LocalizationDateTime",
"LocalizationDateLongTime"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+DocumentType": {
"enum": [
"None",
"File",
"Link",
"Folder"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+DynamicDashboardNumberCalculation": {
"enum": [
"Sum",
"Count",
"Min",
"Max",
"Average",
"Product"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+DynamicDateType": {
"enum": [
"AfterToday",
"BeforeToday"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookIOPPType": {
"enum": [
"No",
"Yes31",
"Yes32",
"Yes33"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLiquid": {
"enum": [
"Water",
"GreyWater",
"Bilge",
"Sludge",
"CargoOil",
"Slop",
"Fuel",
"LubeOil",
"Chemical"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook": {
"enum": [
"ORBI",
"ORBII",
"ODSRB",
"GRB",
"CRB",
"BRB",
"ERB",
"RRB",
"DRB"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookProductClass": {
"enum": [
"Water",
"GreyWater",
"LubeOil",
"Fuel",
"Sludge",
"Bilge",
"Slop",
"SewageSlop",
"Chemical",
"CargoOil",
"CargoOilChemical"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+EmailStatus": {
"enum": [
"AwaitingTransmission",
"Sent",
"Failed"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+EvaluationProcess": {
"enum": [
"RejectingRFQ",
"PlacingPurchaseOrder",
"ReceivingRequisition",
"ReceivingShipment",
"TransitReceiving",
"EvaluateSupplier",
"ReceivingPurchaseOrder",
"EvaluateImInvoice"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+EventPostponementStatus": {
"enum": [
"None",
"Requested",
"Approved"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+EventStatus": {
"enum": [
"Draft",
"Assigned",
"Postponed",
"Completed",
"AwaitingReview",
"Cancelled"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ExchangeMethod": {
"enum": [
"Sequential",
"FlowThrough",
"Dilution"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ExternalDocmentationSource": {
"enum": [
"Job",
"Component",
"Procedure",
"SafetyProcedure",
"Options"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+FieldFormFieldsTypeColumnTypes": {
"enum": [
"StaticText",
"InputText",
"InputTextM",
"Number",
"DateTimePicker",
"Checkbox",
"ListOfValues",
"Dropdown",
"PictureArea",
"SectionHeader",
"StaticTextTextBox",
"Signature",
"Table",
"HelpImage",
"Hyperlink"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormApproverAddedBy": {
"enum": [
"User",
"Automatic",
"Manually"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormApproverStatus": {
"enum": [
"Open",
"AwaitingApproval",
"Approved",
"Rejected",
"ApprovalNotNeeded"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormStatus": {
"enum": [
"Open",
"AwaitingApproval",
"Approved",
"Rejected"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormTemplateCustomPropertyDataType": {
"enum": [
"Bool",
"String",
"Date"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormTemplateFormEditor": {
"enum": [
"Document",
"RiskAssessment",
"Sertica"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormTemplateTableColumnSetupDataType": {
"enum": [
"Numeric",
"Date",
"String",
"Checkbox",
"Dropdown"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+FrequencyType": {
"enum": [
"Minutes",
"Hours",
"Days",
"Months",
"Seconds"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+GenericReportType": {
"enum": [
"Requisition",
"PurchaseOrder",
"RequestForQuote",
"Job",
"JobList",
"PurchaseOrderServiceOrder",
"Reminder",
"DockList",
"Shipment"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+GreenSteamStatus": {
"enum": [
"None",
"AwaitingGreenSteam",
"NoDataFound",
"Completed"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceDocumentType": {
"enum": [
"VendorInvoice",
"VendorCreditNote",
"InternalInvoice",
"InternalCreditNote",
"Prepayment",
"Purchase",
"PrepaymentCreditNote"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceInterfaceDocumentType": {
"enum": [
"None",
"NormalInvoice",
"DetailedInvoice",
"ApprovedInvoice",
"CostInvoice",
"TemporaryInvoice"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceSetPOStatus": {
"enum": [
"Auto",
"PartlyInvoiced",
"FullyInvoiced"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus": {
"enum": [
"Draft",
"AwaitingApproval",
"Approved",
"Rejected",
"OnHold",
"ApprovedOnHold",
"PostApprovalRequired"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageArea": {
"enum": [
"SerticaForm",
"Forum",
"Workshop",
"SparePart",
"Job",
"JobHistory",
"DockJob",
"Component",
"Inspection",
"JobRequest",
"LogbookEvent",
"FormTemplateHelpImage",
"ElectronicLogbooks"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension": {
"enum": [
"DimensionOriginal",
"Dimension1536x1152",
"Dimension1280x960",
"Dimension1024x768",
"Dimension800x600"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+InspectionJobHistoryStatus": {
"enum": [
"Open",
"Closed"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+InspectionListOperationDuringInspectionType": {
"enum": [
"Undecided",
"DryDock",
"Port",
"EnRoute",
"Remote",
"OfficeAudit"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+InspectionListStatus": {
"enum": [
"Open",
"Ongoing",
"Closed"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+InvoiceStatus": {
"enum": [
"NotInvoiced",
"PartlyInvoiced",
"FullyInvoiced"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobFormTemplateDefaultAction": {
"enum": [
"Activation",
"Completion"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobHistoryStatus": {
"enum": [
"None",
"Open",
"Final"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobInstancePostponementStatus": {
"enum": [
"All",
"NotRequested",
"Requested",
"Rejected",
"Approved"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobRecommendationStatus": {
"enum": [
"Pending",
"JobCreated",
"Rejected"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+LabelType": {
"enum": [
"Item",
"ItemLocation",
"Component",
"Measurement",
"Counter",
"JobRequestTemplate",
"Barricade"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+LogLevel": {
"enum": [
"Low",
"Normal",
"High",
"Critical"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+LogSource": {
"enum": [
"Sertica",
"LogiholdServer",
"ScheduledTaskDatabaseBackup",
"ScheduledTaskTransactionImport",
"ScheduledTaskTransactionExport",
"ScheduledTaskEposExchange",
"ScheduledTaskCounterImportFile",
"ScheduledTaskCounterImportODBC",
"ScheduledTaskCounterImportFixedCharFile",
"ScheduledTaskCounterImportFTP",
"ScheduledTaskNavisionExchange",
"ScheduledTaskCounterImportOLEDB",
"ScheduledTaskEmailNotificationUnclosedWeekReports",
"ScheduledTaskEmailNotificationUnapprovedWeekReports",
"ScheduledTaskSendEmails",
"ScheduledTaskGenerateBIReports",
"ScheduledTaskGenerateWeekReportsForSickOrInjured",
"ScheduledTaskEmailNotificationForSickOrInjuredUsers",
"ScheduledTaskGenerateJobMonitorReports",
"ScheduledTaskMeridianImport",
"ScheduledTaskMeridianExport",
"ScheduledTaskGenerateWorkPlan",
"ScheduledTaskGenerateWorkPlans",
"ScheduledTaskCheckCommunicationStatus",
"UnitExport",
"ScheduledTaskGlomarisCimmitmentDailyExport",
"ScheduledTaskRebuildDatabaseIndexes",
"ScheduledTaskVoyageReportCargoImport",
"ScheduledTaskVoyageReportCargoExport",
"ScheduledTaskCalculateAllDashboardData",
"ScheduledTaskOPCCounterImport",
"ScheduledTaskOPCAlarmImport",
"ScheduledTaskProcurementInvoiceQueue",
"ScheduledTaskCalculateCloseOutPerformancePerGroup",
"ScheduledTaskGenerateWeekReports",
"ScheduledTaskUpdateMailAddressesFromAD",
"ScheduledImportProcurementIncomingMails",
"IosHostedService",
"ImportNavisionXml",
"InterfaceQueueExport",
"ImportCurrencyRatesXml",
"CalculateFutureSparePartUsage",
"ShipServ",
"ScheduledTaskUpdateNextKnownPort",
"SparePartStockExportImport",
"ScheduledTaskVoyageReport2CargoImport",
"ScheduledTaskProcessAnalyticsSubscriptions",
"ScheduledTaskMeasurementImportOLEDB",
"ScheduledTaskVoyageReport2CargoExport",
"ScheduledTaskGreenSteamDataImport",
"ScheduledTaskUpdateManagerFromAD",
"ScheduledTaskAccrualExport",
"ScheduledTaskCompleteAcknowledgedForumThreads",
"ScheduledImportComponentGTMSDataIncomingMails",
"TaskSchedulerMode",
"ScheduledTaskCalculateFutureJobInstances",
"SendApprovalPushNotifications",
"SerticaWebApi",
"SerticaWebClient",
"OpusCapita",
"SeaProc",
"ScheduledTaskAutoDeleteForms",
"Connect",
"ScheduledSendExpiredDocument",
"CsvInvoiceImport",
"ScheduledRequestFormsApproval",
"ScheduledTaskProcessAnalyticsDataWarehouseExport",
"ScheduledTaskImportProductsFromAzure",
"ScheduledTaskExportJobDemandsToAzure",
"ScheduledTaskImportJobDemandStatusFromAzure",
"ScheduledTaskCalculateJobDemands",
"ScheduledTaskImportExportMVS",
"ScheduledTaskImportMVSVoyageReportCargo",
"ScheduledTaskCalculateLeadTimes",
"ScheduledTaskCalculateJobFrequency",
"ScheduledTaskCalculateMeanTimeBetweenFailure",
"ScheduledTaskPurchaseOrderRecommendations",
"ScheduledTaskDeactivateInactiveUsers",
"SerticaSync",
"ScheduledTaskImportMVSVoyageReportCargoUpdates",
"ScheduledTaskBudgetCreateNewForecasts",
"ScheduledTaskUploadAnalyticsReportCSVFilesToAzureBlobStorage",
"Source2Sea",
"PunchOut",
"ScheduledTaskBudgetAccrualExport",
"ScheduledTaskCleanupPropertyDefinitionValues",
"ScheduledTaskBudgetExternalCommittedCostExport",
"ScheduledTaskReceivePunchoutOrderConfirmations",
"ScheduledTaskPublishManagementSystem",
"ScheduledTaskRunMasterDataManagementTask",
"ScheduledTaskLogbookOperationPrintoutBackup"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+LogType": {
"enum": [
"Debug",
"ProgramInfo",
"UserNotification",
"Transaction"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ManagementSystemDocumentStatus": {
"enum": [
"NoOutstaningChangeProposals",
"OutstandingChangeProposals",
"OutstandingChanges"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+MeasurementTypeFormat": {
"enum": [
"HourConsumption",
"DailyConsumption",
"WeeklyConsumption",
"MonthlyConsumption",
"QuarterlyConsumption",
"AnnualConsumption"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+OfficeLabelType": {
"enum": [
"Carrier"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationCarriedOutType": {
"enum": [
"Ingress",
"Uptake"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationStatus": {
"enum": [
"Signable",
"Signed",
"Unknown",
"DeletionPendingSignature",
"Deleted"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+OrderBy": {
"enum": [
"None",
"JobNo",
"NextDate",
"LastDoneDateNextDate"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+PaymentConditionOffset": {
"enum": [
"CurrentDate",
"CurrentMonth"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementBudgetStatus": {
"enum": [
"Draft",
"OfficePreparation",
"UnitPreparation",
"AwaitingApproval",
"Approved",
"Active",
"Retired"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionStatus": {
"enum": [
"NotRequested",
"Requested",
"RequisitionHandling",
"Rejected",
"Ordered",
"PartlyOrdered",
"PartlyReceived",
"Received",
"Cancelled"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionTypeEnum": {
"enum": [
"NormalShip",
"LocalShip",
"NormalLand",
"ServiceOrder"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionWorkflow": {
"enum": [
"Draft",
"AwaitingTechnicalReview",
"ReadyForRFQ",
"AwaitingQuote",
"ReadyForOrder",
"Closed",
"AwaitingUnitRespecification",
"AwaitingRequest"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+PunchOutStatus": {
"enum": [
"Draft",
"Waiting",
"Received"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+PunchOutType": {
"enum": [
"Standard",
"Webhook"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderConfirmStatus": {
"enum": [
"None",
"WaitingForReply",
"DeclinedBySupplier",
"AcceptedBySupplier"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderConfirmedVia": {
"enum": [
"None",
"Email",
"Phone",
"Fax",
"Connect",
"Other",
"OpenTRANS",
"ShipServ",
"Tobit",
"EDI",
"SeaProc",
"Source2Sea",
"PunchOut"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderStatus": {
"enum": [
"NotOrdered",
"Ordered",
"PartlyReceived",
"Received",
"Cancelled"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderWorkflow": {
"enum": [
"Draft",
"AwaitingPriceApproval",
"AwaitingOrder",
"OpenForChanges",
"Closed",
"AwaitingGatekeeperReview",
"NotApproved"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+RatingTypeDisplay": {
"enum": [
"ShowAsCheckbox",
"ShowAsList"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ReasonType": {
"enum": [
"ApproveOnHold",
"InvoiceManagement",
"ReceiveGoods"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+RecurrenceType": {
"enum": [
"Daily",
"Weekly",
"Monthly",
"Yearly"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequestForQuoteReceivedVia": {
"enum": [
"None",
"Email",
"Phone",
"Fax",
"Connect",
"Excel",
"Other",
"ShipServ",
"SeaProc",
"ConnectHub"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequestForQuoteStatus": {
"enum": [
"Draft",
"Waiting",
"Received",
"Rejected",
"Ordered",
"Ignored"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequestForQuoteWorkflow": {
"enum": [
"Draft",
"AwaitingQuote",
"AwaitingApproval",
"ApprovedForOrder",
"QuoteRejected",
"Closed",
"AwaitingUnitApproval",
"ApprovedByUnit"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequisitionForwardType": {
"enum": [
"ForwardAllToTechnicalApproval",
"ForwardAllToAwaitingOrder",
"ForwardSelectedAccountsToTechnicalApproval",
"ForwardSelectedAccountsToAwaitingOrder",
"ForwardAllToRFQ",
"ForwardSelectedAccountsToRFQ"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SMTPAuthenticationType": {
"enum": [
"Basic",
"OAuth2O365Graph"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SMTPLoginMethod": {
"enum": [
"Login",
"None"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ScheduledTaskType": {
"enum": [
"UserDefined",
"System"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SealAffixReason": {
"enum": [
"NotAffixed",
"Orbi",
"Operation",
"Inspection",
"Maintenance"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SealBreakReason": {
"enum": [
"NotBroken",
"Orbi",
"Operation",
"Inspection",
"Maintenance",
"Accidental"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SealStatus": {
"enum": [
"New",
"Available",
"Affixed",
"Broken",
"NotValid",
"Lost"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SealSubSealPointType": {
"enum": [
"Affixed",
"Broken"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SendMethod": {
"enum": [
"Direct",
"Queue",
"Outlook",
"Mapi"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipdexMeasureUnit": {
"enum": [
"assy",
"C",
"CCL",
"cg",
"cm",
"cm2",
"cm3",
"D",
"dag",
"dal",
"dam",
"dg",
"dl",
"dm",
"dm2",
"dm3",
"dr",
"dz",
"ft",
"ft3",
"fz",
"gi",
"gl",
"gn",
"hf",
"hg",
"hl",
"hm",
"hm3",
"HS",
"HW",
"HY",
"in",
"in2",
"kg",
"km",
"kt",
"l",
"lb",
"lm",
"lo",
"Lt",
"m",
"m2",
"m3",
"Mft",
"Mft3",
"mg",
"ml",
"mm",
"mm2",
"ot",
"oz",
"pb",
"pc",
"pr",
"pt",
"qt",
"ra",
"rm",
"se",
"sh",
"sk",
"so",
"t",
"tn",
"ui",
"um",
"yd",
"yd2",
"yd3",
"zv"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipdexMemberArea": {
"enum": [
"sk01",
"sk02",
"sk03"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipdexSpecification": {
"enum": [
"pc01",
"pc02",
"pc03",
"pc04",
"pc05",
"pc06",
"pc07",
"pc08",
"pc09",
"pc10"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipmentStatus": {
"enum": [
"Draft",
"Picking",
"Picked",
"Shipped",
"PartlyReceived",
"Received",
"Cancelled"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipmentType": {
"enum": [
"Final",
"Warehouse",
"Landing"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SparePartWarehouseHistoryType": {
"enum": [
"Default",
"Init",
"WriteUpStock",
"WriteDownStock",
"Requisition",
"JobHistory",
"PriceUpdate",
"ResetStock",
"StatusStock",
"StatusCount"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+StartupParameter": {
"enum": [
"None",
"DatabaseBackup",
"Synchronize",
"CounterImportFile",
"CounterImportODBC",
"CounterImportFixedCharFile",
"CounterImportFTP",
"Help",
"TransactionImport",
"TransactionExport",
"DatabaseBackupWithZipAndMove",
"NavisionExchange",
"CounterImportOLEDB",
"EmailNotificationUnclosedWeekReports",
"EmailNotificationUnApprovedWeekReports",
"SendEmails",
"GenerateWeekReportsForSickOrInjured",
"EmailNotificationOfSickOrInjuredUsers",
"ExportTodaysJobToPdfAndMail",
"GenerateJobMonitorReports",
"MeridianImport",
"MeridianExport",
"GenerateWorkPlans",
"CheckCommunicationStatus",
"PDAJobImport",
"PDAJobHistoryImport",
"GlomarisCommitmentDailyExport",
"RebuildDatabaseIndexes",
"EmailFollowUpOnDeletedComponents",
"ImportVoyageReportCargo",
"GenerateWeekReports",
"ExportVoyageReportCargo",
"CalculateAllDashboardData",
"EmailNotificationForJob",
"OPCCounterImport",
"OPCAlarmImport",
"ProcessProcurementInvoiceQueue",
"CalculateCloseOutPerformancePerGroup",
"UpdateMailAddressesFromAD",
"ImportProcurementIncomingMails",
"IosHostedService",
"ImportNavisionXml",
"InterfaceQueueExport",
"DeleteOldLogData",
"IntegrationImportExport",
"JournalCreateTodaysJournal",
"CreateShiftPlans",
"GenerateHealthStatisticsReports",
"GenerateCertificateNotifications",
"GenerateReminders",
"ImportDynamicsAXVestfrost",
"ImportCurrencyRatesXml",
"CalculateFutureSparePartUsage",
"UpdateNextKnownPort",
"SparePartStockImport",
"ImportVoyageReport2Cargo",
"SparePartConsumptionExport",
"ProcessAnalyticsSubscriptions",
"MeasurementImportOLEDB",
"ExportVoyageReport2Cargo",
"IntegrationComponentExport",
"IntegrationUserImport",
"ImportGreenSteamData",
"IntegrationInvoiceImport",
"IntegrationInvoiceExport",
"IntegrationSupplierExport",
"IntegrationPurchaseOrderExport",
"ReAutomatchImInvoice",
"IntegrationWeekReportExport",
"IntegrationPurchaseOrderResponseImport",
"AccrualExport",
"UpdateManagerFromAD",
"EconomicsInvoiceExport",
"IntegrationAccrualExport",
"CompleteAcknowledgedForumThreads",
"IntegrationShipServImportExport",
"IntegrationSupplierImport",
"IntegrationVismaSupplierExport",
"IntegrationMDMSupplierExport",
"ImportComponentGtmsData",
"GenerateAccruals",
"TaskSchedulerMode",
"CalculateFutureJobInstances",
"SendApprovalPushNotifications",
"UpdateLocalizationLanguageXML",
"IntegrationCommittedCostImport",
"GenerateOutstandingForumAcknowledgements",
"ImInvoiceProcessMonthEnd",
"IntegrationInvoiceInfoImport",
"CheckIdleSupplier",
"ManagementSystemReadCleanup",
"DocumentImport",
"DisableAutologin",
"CleanupMail",
"OpusCapitaImportInvoicesFromXml",
"IntegrationSeaProcImportExport",
"AutoDeleteForms",
"IntegrationRequisitionExport",
"IntegrationConnectImportExport",
"CsvInvoiceImport",
"IntegrationBudgetForecastExport",
"SendExpiredDocument",
"RequestFormsApproval",
"CalculateVacation",
"ProcessAnalyticsDataWarehouseExport",
"RebuildFullTextConfiguration",
"ImportProductsFromAzure",
"ExportJobDemandsToAzure",
"ImportJobDemandStatusFromAzure",
"CalculateJobDemands",
"ImportExportMVS",
"ImportMVSVoyageReportCargo",
"DeleteOldApiLogData",
"DeleteOldAppLogData",
"CalculateLeadTimes",
"CalculateJobFrequency",
"CalculateMeanTimeBetweenFailure",
"SparePartStockExport",
"PurchaseRecommendations",
"IntegrationPurchaseOrderWarehouseInformationImport",
"IntegrationTransitReceptionImport",
"IntegrationTaxCodeImport",
"IntegrationCurrencyImport",
"DeactivateInactiveUsers",
"AzureServiceBusDeleteLogMessages",
"AddDefaultWarehouse",
"UpdateLicense",
"ResetLmcPassword",
"UpgradeDatabase",
"IntegrationAccountImport",
"GetAzureServiceBusQueuePurchaseOrderFeedbackMessages",
"ImportMVSVoyageReportCargoUpdates",
"WebhookCurrency",
"WebhookInvoiceInfo",
"BudgetCreateNewForecasts",
"UploadAnalyticsReportCSVFilesToAzureBlobStorage",
"IntegrationSource2SeaImportExport",
"DeleteOldWebhookLogData",
"BudgetAccrualExport",
"CleanupPropertyDefinitionValues",
"BudgetExternalCommittedCostExport",
"CleanupTaskSchedulerQueue",
"IntegrationIncidentImport",
"WebhookSchedule",
"DeleteOldAnalyticsStatistics",
"DeleteHandledInterfaceQueue",
"IntegrationItemExport",
"ReceivePunchoutOrderConfirmations",
"PublishManagementSystem",
"RunMasterDataManagementTask",
"LogbookOperationPrintoutBackup",
"EnsureMdmPackageUnit"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+StockValue": {
"enum": [
"FIFO",
"PresentValue"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SubSealPointStatus": {
"enum": [
"Unsealed",
"Sealed"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SupplierForwardType": {
"enum": [
"None",
"Email",
"EmailWeb",
"Excel",
"Tobit",
"ShipServ",
"SeaProc",
"Connect"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+SupplierPurchaseOrderForwardType": {
"enum": [
"None",
"Email",
"EmailWeb",
"ShipServ",
"OpenTRANS",
"Tobit",
"EDI",
"SeaProc",
"Connect",
"Source2Sea",
"Punchout"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+TankVarianceType": {
"enum": [
"None",
"Warning",
"Blocking"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+TaskStatus": {
"enum": [
"Inactive",
"Waiting",
"Running",
"Completed",
"Failed",
"Cancelled",
"LockedOut"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+TransactionDirection": {
"enum": [
"Outgoing",
"Incoming"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+TransactionStatus": {
"enum": [
"Open",
"Closed",
"TransmittedToWS",
"ReceivedInWS",
"ReceivedInLH",
"VersionConflict",
"Error",
"Retransmit",
"Confirmed",
"Final",
"Missing",
"ManualTransfer"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+TransitReceivedStatus": {
"enum": [
"NotReceived",
"PartlyReceived",
"Received"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+TriggerType": {
"enum": [
"AllTriggers",
"RunOnceTrigger",
"RecurringTrigger",
"CounterTrigger",
"MeasurementTrigger",
"DockTrigger",
"OPCAlarmTrigger",
"JobSequenceCalendarTrigger",
"JobSequenceCounterTrigger"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+UnitForSale": {
"enum": [
"No",
"Yes"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+UpdateSupplierItemPriceWhenApproveInvoice": {
"enum": [
"NoUpdate",
"PromptForUpdate",
"AlwaysUpdate"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+UserEmbarkationStatus": {
"enum": [
"Unknown",
"Disembarked",
"Embarked"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageDataSource": {
"enum": [
"Manual",
"GreenSteam",
"Excel"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2ConsumptionSources": {
"enum": [
"ME",
"AUX",
"Boiler",
"Offhire"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2SeaState": {
"enum": [
"SeaLikeAMirror",
"RipplesWithScales",
"SmallWavelets",
"LargeWavelets",
"SmallWaves",
"ModerateLongerWaves",
"LargeWaves",
"SomeHeapsUp",
"ModerateHeighWaves",
"HighWaves",
"VeryHighWaves",
"ExceptionalHighWaves",
"AirFilledWithFoamAndSpray"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2TugsReason": {
"enum": [
"Weather",
"EquipmentFailure",
"ExternalRequirement",
"Other"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2WindDirection": {
"enum": [
"N",
"NNE",
"NE",
"ENE",
"E",
"ESE",
"SE",
"SSE",
"S",
"SSW",
"SW",
"WSW",
"W",
"WNW",
"NW",
"NNW"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2WindForce": {
"enum": [
"Calm",
"LightAir",
"LigtBreeze",
"GentleBreeze",
"ModerateBreeze",
"FreshBreeze",
"StrongBreeze",
"HighWind",
"Gale",
"StrongGale",
"Storm",
"ViolentStorm",
"Hurricane"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebDashboardContentDimension": {
"enum": [
"Single",
"Multiple"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebDashboardContentType": {
"enum": [
"AnalyticsReportView",
"AnalyticsGraph",
"DocumentPreview",
"WebLink",
"ComponentOverview",
"PowerBI"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebDashboardNumberSource": {
"enum": [
"ExcelFieldValue",
"Count",
"CalculatedField"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebDashboardPageFilterType": {
"enum": [
"Date",
"Number",
"Text",
"Checkbox"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebhookLogStatus": {
"enum": [
"Error",
"Resolved",
"InSync"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebhookStatus": {
"enum": [
"Draft",
"Active",
"Inactive"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.UpdateUnitsIssue": {
"type": "object",
"properties": {
"reason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.UpdateUnitsIssueReason"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.UpdateUnitsIssueReason": {
"enum": [
"DuplicateDataOnUnit"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.UserManagement.InextiaUserRightIndexType": {
"enum": [
"Root",
"Group",
"Entity",
"GeneralUserRights",
"FieldUserRights",
"ReferenceUserRights"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.View.SortDirection": {
"enum": [
"Asc",
"Desc"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.WebDashboardModels.WebDashboardContentUsageView": {
"type": "object",
"properties": {
"webDashboardPageNo": {
"type": "string",
"nullable": true
},
"webDashboardPageName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.WebDashboardModels.WebDashboardPageUsageView": {
"type": "object",
"properties": {
"webDashboardNo": {
"type": "string",
"nullable": true
},
"webDashboardName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportApprovalFlow": {
"enum": [
"None",
"Fixed"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportApprovalStatus": {
"enum": [
"Open",
"AwaitingApproval",
"Approved",
"Rejected",
"ApprovalNotNeeded"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportApproverAddedBy": {
"enum": [
"User",
"Automatic",
"Manually"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTableColumnDataType": {
"enum": [
"String",
"Number",
"DateTime",
"Duration",
"Bool",
"List",
"Reference",
"Document"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTableColumnReference": {
"enum": [
"VesselReport",
"Port"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTypeFieldDataType": {
"enum": [
"None",
"String",
"Bool",
"Signature",
"Decimal",
"Coordinates",
"Int",
"List",
"Date",
"DateTime",
"Time",
"Reference",
"StaticText",
"Document",
"Table"
],
"type": "string"
},
"Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTypeFieldDefinitionScriptUsage": {
"type": "object",
"properties": {
"vesselReportTypeGuid": {
"type": "string",
"format": "uuid"
},
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeName": {
"type": "string",
"nullable": true
},
"definitionId": {
"type": "string",
"nullable": true
},
"calculationScript": {
"type": "string",
"nullable": true
},
"validationScript": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"dataType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTypeFieldDataType"
},
"layout": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Logihold.BusinessObjects.LogiholdObjModel.WordFields": {
"enum": [
"Subject",
"EventReportUnitLead",
"EventReportCompanyLead",
"FormRemarks",
"UnitNo",
"UnitName",
"UnitImoNo",
"UnitVesselTypeName",
"UnitCallSign",
"UnitGrossTonage",
"UnitHomePort",
"UnitManager",
"UnitFlagName",
"UnitClassName",
"UnitMMSI",
"UnitNetTonnage",
"UnitDeadweight",
"UnitOfficialNumber",
"UnitClassId",
"UnitSatCNo",
"UnitSatTelephoneNo",
"UnitSatFaxNo",
"UnitEmail",
"UnitYard",
"UnitYardNo",
"UnitKeelLaid",
"UnitBuiltDate",
"FormReportNo",
"FormReportDate",
"FormStatus",
"FormReportedBy",
"FormTitleOfReportedUser",
"FormTemplateNo",
"FormTemplateName",
"FormTemplateRevisionNo",
"FormTemplateRevisionDate",
"LatestChangeRequestCreateUserNo",
"LatestChangeRequestCreateUserName",
"LatestChangeRequestApprover1UserNo",
"LatestChangeRequestApprover1UserName",
"LatestChangeRequestApprover2UserNo",
"LatestChangeRequestApprover2UserName",
"FormCreatedDate",
"FormTemplateDocumentUpdateUser",
"FormTemplateReference",
"FormApproverNo1",
"FormApproverName1",
"FormApproverUpdateDate1",
"FormApproverUpdateUserNo1",
"FormApproverUpdateUserName1",
"FormApproverUpdateUserTitle1",
"FormApproverStatus1",
"FormApproverNo2",
"FormApproverName2",
"FormApproverUpdateDate2",
"FormApproverUpdateUserNo2",
"FormApproverUpdateUserName2",
"FormApproverUpdateUserTitle2",
"FormApproverStatus2",
"FormApproverNo3",
"FormApproverName3",
"FormApproverUpdateDate3",
"FormApproverUpdateUserNo3",
"FormApproverUpdateUserName3",
"FormApproverUpdateUserTitle3",
"FormApproverStatus3",
"FormApproverNo4",
"FormApproverName4",
"FormApproverUpdateDate4",
"FormApproverUpdateUserNo4",
"FormApproverUpdateUserName4",
"FormApproverUpdateUserTitle4",
"FormApproverStatus4",
"FormApproverNo5",
"FormApproverName5",
"FormApproverUpdateDate5",
"FormApproverUpdateUserNo5",
"FormApproverUpdateUserName5",
"FormApproverUpdateUserTitle5",
"FormApproverStatus5",
"CustomFieldText1",
"CustomFieldText2",
"CustomFieldText3",
"CustomFieldText4",
"CustomFieldText5",
"CustomFieldText6",
"CustomFieldText7",
"CustomFieldText8",
"CustomFieldText9",
"CustomFieldText10",
"CustomFieldNumeric1",
"CustomFieldNumeric2",
"CustomFieldNumeric3",
"CustomFieldNumeric4",
"CustomFieldNumeric5",
"CustomFieldNumeric6",
"CustomFieldNumeric7",
"CustomFieldNumeric8",
"CustomFieldNumeric9",
"CustomFieldNumeric10",
"CustomFieldNumeric11",
"CustomFieldNumeric12",
"CustomFieldNumeric13",
"CustomFieldNumeric14",
"CustomFieldNumeric15",
"CustomFieldNumeric16",
"CustomFieldNumeric17",
"CustomFieldNumeric18",
"CustomFieldNumeric19",
"CustomFieldNumeric20",
"CustomFieldDateTime1",
"CustomFieldDateTime2",
"CustomFieldDateTime3",
"CustomFieldDateTime4",
"CustomFieldDateTime5",
"CustomFieldDateTime6",
"CustomFieldDateTime7",
"CustomFieldDateTime8",
"CustomFieldDateTime9",
"CustomFieldDateTime10",
"CustomFieldCheckbox1",
"CustomFieldCheckbox2",
"CustomFieldCheckbox3",
"CustomFieldCheckbox4",
"CustomFieldCheckbox5",
"CustomFieldCheckbox6",
"CustomFieldCheckbox7",
"CustomFieldCheckbox8",
"CustomFieldCheckbox9",
"CustomFieldCheckbox10",
"CustomFieldMultilineText1",
"CustomFieldMultilineText2",
"CustomFieldMultilineText3",
"CustomFieldMultilineText4",
"CustomFieldMultilineText5",
"CustomFieldMultilineText6",
"CustomFieldMultilineText7",
"CustomFieldMultilineText8",
"CustomFieldMultilineText9",
"CustomFieldMultilineText10",
"CustomFieldMultilineText11",
"CustomFieldMultilineText12",
"CustomFieldMultilineText13",
"CustomFieldMultilineText14",
"CustomFieldMultilineText15",
"EventReportNo",
"EventReportType",
"EventReportEventDepartment",
"EventReportDateTimeOfEvent",
"EventReportResponsible",
"EventReportStatus",
"EventReportDueDate",
"EventReportOriginalDueDate",
"EventReportProgressInitiated",
"EventReportCompletedClosed",
"EventReportPostponedDate",
"EventReportPostponedStatus",
"EventReportExpectedCompleteDate",
"EventReportGroundsReason",
"EventReportGrounds",
"EventReportEnforceConfidentiality",
"EventReportResponseLog",
"EventReportDocuments",
"EventReportDescriptionOfEvent",
"EventReportImmediateCause",
"EventReportCorrectiveAction",
"EventReportCorrectiveActionText",
"EventReportPreventativeMeasures",
"EventReportPreventativeMeasuresText",
"EventReportCorrectionText",
"EventReportInitialComments",
"EventReportSubsequentComments",
"EventReportRiskIndex",
"EventReportDetained",
"EventReportConventionRef",
"EventReportGroupCode",
"EventReportActionCode",
"EventReportStandardReference",
"EventReportActivityOfTheUnit",
"EventReportActivityOfThePerson",
"EventReportLocation",
"EventReportPositionRank",
"EventReportHumanManning",
"EventReportWorkingEnvoirment",
"EventReportExternalEnvoirment",
"EventReportTechnical",
"EventReportEventHeading",
"EventReportMechanism",
"EventReportContact",
"EventReportIndividual",
"EventReportEnvoirment",
"EventReportUnit",
"EventReportThridParty",
"EventReportWeatherConditions",
"EventReportWindForce",
"EventReportWindDirection",
"EventReportSeaState",
"EventReportOther",
"EventReportManagement",
"CauseAnalysisText",
"EventReportISMRelatedDeficiency",
"EventReportCeforMainEventCode",
"EventReportCeforMainCasualtyCode",
"EventReportCeforCauseCode",
"EventReportGrossEstimate",
"EventReportOwnRetention",
"EventReportNetClaimToInsurance",
"EventReportReserve",
"EventReportPaid",
"EventReportActualRepairCosts",
"EventReportOtherCosts",
"EventReportTotalCosts",
"EventReportOwnersCost",
"EventReportSuperintendentActualRepairCosts",
"EventReportEstimatedRepairCost",
"EventReportActualRepairCost",
"EventReportEstimatedOffHireDays",
"EventReportActualOffHireDays",
"EventReportCeforCodesValidated",
"EventReportFinancialFiguresEstimated",
"EventReportLessonsLearnedDistributed",
"EventReportIdentifiedArea",
"EventReportProbRecurrenceRate",
"EventReportSeverity",
"ActivityManagementNo",
"ActivityManagementTitle",
"ActivityManagementType",
"ActivityManagementConfirmedStartDate",
"ActivityManagementConfirmedEndDate",
"ActivityManagementCompletedDate",
"ActivityManagementSurveyOrganization",
"ActivityManagementPlaceOfInspection",
"ActivityManagementSurveyors",
"ActivityManagementSendRectRepTo",
"BunkeringPortName",
"BargeName",
"VesselStandbyForBunkersDate",
"VoyageNo",
"ManagementSystemROCRevisionDate",
"ManagementSystemROCRevisionNo",
"ManagementSystemNo",
"ManagementSystemTitle",
"ManagementSystemHeadLine",
"ManagementSystemCheckTitle",
"ManagementSystemChangeRequestRequestedDate",
"ManagementSystemChangeRequestNo",
"ManagementSystemChangeRequestRequestedByNo",
"ManagementSystemChangeRequestRequestedByName",
"ManagementSystemChangeRequestSourceNo",
"ManagementSystemChangeRequestSourceName",
"ManagementSystemChangeRequestCriticalityNo",
"ManagementSystemChangeRequestCriticalityName",
"ManagementSystemChangeRequestDescription",
"JobNo",
"JobName",
"JobDescription",
"JobComponentNo",
"JobComponentName",
"EventPictureTable",
"ActivityPictureTable",
"FormLargestResidualRisk",
"FormRiskNo",
"FormRiskName",
"FormRiskDescription",
"FormRiskAreaNo",
"FormRiskAreaName",
"FormRiskRecurrencyBeforeNo",
"FormRiskRecurrencyBeforeName",
"FormRiskSeverityBeforeNo",
"FormRiskSeverityBeforeName",
"FormRiskIndexBefore",
"FormRiskControls",
"FormRiskRecurrencyAfterNo",
"FormRiskRecurrencyAfterName",
"FormRiskSeverityAfterNo",
"FormRiskSeverityAfterName",
"FormRiskIndexAfter",
"FormRiskCompanyLeadComment",
"FormRiskResponsibleNo",
"FormRiskResponsibleName",
"SupplierApprovalCompanyNo",
"SupplierApprovalCompanyName",
"SupplierApprovalAddressNo",
"SupplierApprovalAddressName",
"MeasurementName",
"MeasurementDescription",
"MeasurementRemarks",
"MeasurementUnitOfMeasurement",
"MeasurementLatestReadingValue",
"MeasurementLatestReadingDate",
"MeasurementLatestReadingRemark",
"MeasurementReadingValue",
"MeasurementReadingDate",
"MeasurementReadingRemark",
"JobHistoryDoneDate",
"FormApprovalValidUntil",
"CustomFieldCheckbox11",
"CustomFieldCheckbox12",
"CustomFieldCheckbox13",
"CustomFieldCheckbox14",
"CustomFieldCheckbox15",
"CustomFieldCheckbox16",
"CustomFieldCheckbox17",
"CustomFieldCheckbox18",
"CustomFieldCheckbox19",
"CustomFieldCheckbox20",
"CounterName",
"CounterTypeNo",
"CounterTypeName",
"CounterLatestReadingValue",
"CounterLatestReadingDate",
"CounterLatestReadingRemark",
"CounterReadingValue",
"CounterReadingDate",
"CounterReadingRemark",
"ActivityManagementUnitNo",
"ActivityManagementUnitName",
"ActivityManagementDepartmentNo",
"ActivityManagementDepartmentName",
"ActivityManagementDescription",
"ActivityManagementUnitResponsibleNo",
"ActivityManagementUnitResponsibleName",
"ActivityManagementCompanyLeadNo",
"ActivityManagementCompanyLeadName",
"ActivityManagementRemarks",
"ActivityManagementStatus",
"ActivityManagementWindowOpensDate",
"ActivityManagementWindowClosesDate",
"ActivityManagementRectificationDueDate",
"ActivityManagementAllEventsClosedDate",
"ActivityManagementQuestionnaireNo",
"ActivityManagementQuestionnaireName",
"ActivityManagementNumberOfDeficiencies",
"ActivityManagementDeficiencyCategoryNo",
"ActivityManagementDeficiencyCategoryName",
"ActivityManagementInternalScore",
"ActivityManagementInternalScoreCategoryNo",
"ActivityManagementInternalScoreCategoryName",
"ActivityManagementDateOfDetention",
"ActivityManagementDateOfRelease",
"ActivityManagementGrounds",
"CustomFieldDropDown1",
"CustomFieldDropDown2",
"CustomFieldDropDown3",
"CustomFieldDropDown4",
"CustomFieldDropDown5",
"CustomFieldDropDown6",
"CustomFieldDropDown7",
"CustomFieldDropDown8",
"CustomFieldDropDown9",
"CustomFieldDropDown10",
"Port",
"JobPurchaseOrder",
"AddressBook",
"UsersOnUnit",
"FormPictureTable",
"EventReportStandardReference2",
"DefectReportNo",
"DefectReportLocation",
"DefectStatus",
"DefectReportStatus",
"DefectReportReportedByNo",
"DefectReportReportedByName",
"DateTimeOfDefect",
"DefectReportComponentNo",
"DefectReportComponentName",
"DefectReportLastOverhauledJobNo",
"DefectReportLastOverhauledJobName",
"DefectReportSerialNo",
"DefectReportIsCritical",
"DefectReportDate",
"DefectReportRemarks",
"DefectReportDescription",
"DefectReportPrevailingConditions",
"DefectReportAdditionalObservations",
"DefectReportRiskAssessmentNo",
"DefectReportRiskAssessmentStatus",
"DefectReportInvestigationNo",
"DefectReportInvestigationStatus",
"DefectReportInvestigationLocation",
"DefectReportSystemGroupName",
"DefectReportItemName",
"DefectReportLiquidName",
"DefectReportImmediateCause1",
"DefectReportImmediateCause2",
"DefectReportImmediateCause3",
"DefectReportIsDryDock",
"DefectReportBasicCause1",
"DefectReportBasicCause2",
"DefectReportBasicCause3",
"DefectReportProbability",
"DefectReportIsBlackoutEvent",
"DefectReportBlackoutEventRestorationTime",
"DefectReportIsLossOfManoeuvrabilityEvent",
"DefectReportLossOfManoeuvrabilityEventRestorationTime",
"DefectReportSeverityCostCategoryName",
"DefectReportSeveritySafetyImpactName",
"DefectReportSeverityEnvironmentalImpactName",
"DefectReportRisk",
"DefectReportCostBriefEstimationUSD",
"DefectReportJobNo",
"DefectReportJobName",
"DefectReportTechnicalDepartmentRemarks",
"DefectReportResponsibleNo",
"DefectReportResponsibleName",
"DefectReportRectificationTargetDate",
"DefectReportClosingDate",
"DefectReportPostponementDueDate",
"DefectReportIsPostponed",
"DefectReportPostponementRANo",
"DefectReportPostponementRASubject",
"DefectReportIsPreliminaryCE001RequirementStatus",
"DefectReportDIRITApprovedNecessity",
"DefectReportDIRITNecessityRemark",
"DefectReportLeaderNo",
"DefectReportLeaderName",
"DefectReportDueDate",
"DefectReportCloseOutDate",
"EventReportWorkingEnvironment",
"EventReportExternalEnvironment",
"EventReportEnvironment",
"EventReportThirdParty",
"UnitGrossTonnage"
],
"type": "string"
},
"Logimatic.Analytics.Component.Model.AggregationType": {
"enum": [
"None",
"Sum",
"Average",
"Count",
"Minimum",
"Maximum"
],
"type": "string"
},
"Logimatic.Analytics.Component.Model.SortingType": {
"enum": [
"None",
"Ascending",
"Descending"
],
"type": "string"
},
"Logimatic.Analytics.Component.Model.TemplateFieldDisplayType": {
"enum": [
"NumericFromTo",
"DateRange",
"DateDistinctList",
"DateDistinctFilteredList",
"TextLike",
"TextRange",
"TextDistinctList",
"TextDistinctFilteredList",
"SumDefault",
"Boolean",
"DateDynamic",
"Comparison",
"TextEmptyValues",
"DateEmptyValues",
"NumericEmptyValues",
"PrimaryKey",
"UnitGuid",
"SystemFilterColumn",
"DrilldownPrimaryKey",
"DrilldownUnitGuid"
],
"type": "string"
},
"Logimatic.Analytics.Component.Model.TemplateType": {
"enum": [
"SystemTemplate",
"CustomTemplate",
"DataWarehouseTemplate"
],
"type": "string"
},
"Logimatic.BaseClasses30.DataOwner": {
"enum": [
"Unit",
"MasterUnit"
],
"type": "string"
},
"Logimatic.BaseClasses30.IGenerateSqlCommand`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.DischargedProduct, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGenerateSqlCommand`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.GrbOperationEnvironmentalItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGenerateSqlCommand`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateJobRequestMailTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGenerateSqlCommand`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateNotificationUser, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGenerateSqlCommand`1[[Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGenerateSqlWhereClause`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.DischargedProduct, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGenerateSqlWhereClause`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.GrbOperationEnvironmentalItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGenerateSqlWhereClause`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateJobRequestMailTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGenerateSqlWhereClause`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateNotificationUser, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGenerateSqlWhereClause`1[[Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGetConfidentialityColumnDefinition`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.DischargedProduct, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGetConfidentialityColumnDefinition`1[[Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.RelationObjects.GrbOperationEnvironmentalItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGetConfidentialityColumnDefinition`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateJobRequestMailTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGetConfidentialityColumnDefinition`1[[Logihold.BusinessObjects.LogiholdObjModel.JobRequestTemplateNotificationUser, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.IGetConfidentialityColumnDefinition`1[[Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplate, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"additionalProperties": false
},
"Logimatic.BaseClasses30.Rule": {
"type": "object",
"properties": {
"allowBrokenRuleOnMultipleRecords": {
"type": "boolean"
},
"ruleType": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.Rule+RuleTypeEnum"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"property": {
"type": "string",
"nullable": true
},
"property2": {
"type": "string",
"nullable": true
},
"property3": {
"type": "string",
"nullable": true
},
"property4": {
"type": "string",
"nullable": true
},
"searchAllUnits": {
"type": "boolean"
},
"adminOnly": {
"type": "boolean"
},
"denyForceDelete": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Logimatic.BaseClasses30.Rule+RuleTypeEnum": {
"enum": [
"ErrorNoSave",
"WarningCanSave",
"InformationCanSave"
],
"type": "string"
},
"Logimatic.DocumentUtilities.Pdf.ElectronicLogbook.PrintoutEntry": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"columnIndex": {
"type": "integer",
"format": "int32"
},
"rowIndex": {
"type": "integer",
"format": "int32"
},
"subTypeIndex": {
"type": "integer",
"format": "int32"
},
"rowSpan": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Logimatic.StandardFunctionsCS.AIIntegrationFlag": {
"enum": [
"None",
"ManagementSystem"
],
"type": "string"
},
"Logimatic.StandardFunctionsCS.CustomerType": {
"enum": [
"Inextia",
"Sertica"
],
"type": "string"
},
"Logimatic.StandardFunctionsCS.FleetManagementRole": {
"enum": [
"None",
"Unit",
"Fleet"
],
"type": "string"
},
"Logimatic.StandardFunctionsCS.IntegrationMode": {
"enum": [
"None",
"SupplierMustMatchVendor",
"Torm",
"AXMode",
"AddressTypeRestrictions",
"FilterInvoiceFields",
"FilterProjectFields",
"FilterProjectCodeFields",
"AutoGenerateAddressNo",
"ExternalReferencesOnUnit",
"Humboldt",
"EDIInterface",
"MDMInterface",
"OpusCapita",
"RALAX",
"SvitzerAzureServiceBus",
"CozmosAzureServiceBus",
"MintraOCSAPIAdapter",
"ItemWebhookExport"
],
"type": "string"
},
"Logimatic.StandardFunctionsCS.WebhooksMode": {
"enum": [
"RestrictedAccess",
"FullAccess"
],
"type": "string"
},
"Microsoft.AspNetCore.Http.HttpResults.NotFound": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"readOnly": true
}
},
"additionalProperties": false
},
"Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter": {
"type": "object",
"additionalProperties": false
},
"Microsoft.AspNetCore.Mvc.NotFoundObjectResult": {
"type": "object",
"properties": {
"value": {
"nullable": true
},
"formatters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.Formatters.IOutputFormatter"
},
"nullable": true
},
"contentTypes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"declaredType": {
"type": "string",
"nullable": true
},
"statusCode": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"Microsoft.AspNetCore.Mvc.NotFoundResult": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Microsoft.AspNetCore.Mvc.UnauthorizedResult": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"SerticaWebApi.Controllers.PurchaseOrdersController+PurchaseOrderPunchOutAddress": {
"type": "object",
"properties": {
"selectedAddressPunchOut": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Controllers.PurchaseOrdersController+PurchaseOrderRemark": {
"type": "object",
"properties": {
"remark": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Controllers.RequisitionsController+RequisitionPunchOutAddress": {
"type": "object",
"properties": {
"selectedAddressPunchOut": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Controllers.RequisitionsController+RequisitionRemark": {
"type": "object",
"properties": {
"remark": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Accounting.Account": {
"type": "object",
"properties": {
"accountNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Accounting.AccountingDimension": {
"type": "object",
"properties": {
"dimensionNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32",
"nullable": true
},
"availableOnInvoice": {
"type": "boolean",
"nullable": true
},
"availableOnPurchaseOrderHeader": {
"type": "boolean",
"nullable": true
},
"availableOnPurchaseOrderPosition": {
"type": "boolean",
"nullable": true
},
"availableOnRequisitionHeader": {
"type": "boolean",
"nullable": true
},
"availableOnRequisitionPosition": {
"type": "boolean",
"nullable": true
},
"affectorOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionValue"
},
"nullable": true
},
"derivedValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionDerivedValue"
},
"nullable": true
},
"affectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionAccountingDimensionAffector"
},
"nullable": true
},
"mandatoryValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.AccountingDimensionMandatoryValue"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Accounting.AccountingDimensionAccountingDimensionAffector": {
"type": "object",
"properties": {
"accountingDimensionNo": {
"type": "string",
"nullable": true
},
"accountingDimensionName": {
"type": "string",
"nullable": true
},
"dimensionNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid"
},
"affectorOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"availableOnInvoice": {
"type": "boolean",
"nullable": true
},
"availableOnPurchaseOrderHeader": {
"type": "boolean",
"nullable": true
},
"availableOnPurchaseOrderPosition": {
"type": "boolean",
"nullable": true
},
"availableOnRequisitionHeader": {
"type": "boolean",
"nullable": true
},
"availableOnRequisitionPosition": {
"type": "boolean",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Accounting.AccountingDimensionDerivedValue": {
"type": "object",
"properties": {
"dimensionNo": {
"type": "string",
"nullable": true
},
"dimensionName": {
"type": "string",
"nullable": true
},
"derivedValueConfiguration": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Accounting.AccountingDimensionMandatoryValue": {
"type": "object",
"properties": {
"dimensionNo": {
"type": "string",
"nullable": true
},
"dimensionName": {
"type": "string",
"nullable": true
},
"mandatory": {
"type": "boolean",
"nullable": true
},
"readOnly": {
"type": "boolean",
"nullable": true
},
"mandatoryValueConfiguration": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Accounting.AccountingDimensionValue": {
"type": "object",
"properties": {
"dimensionNo": {
"type": "string",
"nullable": true
},
"dimensionName": {
"type": "string",
"nullable": true
},
"valueNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Accounting.ApprovalSetup": {
"type": "object",
"properties": {
"approvalSetupNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"requireAllApproversOnSameLevel": {
"type": "boolean",
"nullable": true
},
"requireAllLevels": {
"type": "boolean",
"nullable": true
},
"allowSingleLevelApproval": {
"type": "boolean",
"nullable": true
},
"skipRolesWithoutUsers": {
"type": "boolean",
"nullable": true
},
"onlyUseLevelsAboveForwarder": {
"type": "boolean",
"nullable": true
},
"onlyUseLevelsAboveRequester": {
"type": "boolean",
"nullable": true
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Accounting.ApprovalSetupCombinedUserRole2"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Accounting.ApprovalSetupCombinedUserRole2": {
"type": "object",
"properties": {
"approvalSetupNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"approvalOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.Address": {
"type": "object",
"properties": {
"addressNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"addressLines": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"zipCode": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"telefax": {
"type": "string",
"nullable": true
},
"mobilePhone": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"homepage": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"frameworkAgreement": {
"type": "boolean"
},
"countryCodeNo": {
"type": "string",
"nullable": true
},
"countryCodeName": {
"type": "string",
"nullable": true
},
"addressTypes": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressTypeSearchFlag"
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"vendorNo": {
"type": "string",
"nullable": true
},
"defaultDiscount": {
"type": "number",
"format": "double",
"nullable": true
},
"paymentConditionNo": {
"type": "string",
"nullable": true
},
"paymentConditionName": {
"type": "string",
"nullable": true
},
"deliveryConditionNo": {
"type": "string",
"nullable": true
},
"deliveryConditionName": {
"type": "string",
"nullable": true
},
"communicationLanguageNo": {
"type": "string",
"nullable": true
},
"communicationLanguageName": {
"type": "string",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"addressAvailability": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AddressAvailable"
},
"vatNo": {
"type": "string",
"nullable": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"defaultDeliveryPlaceNo": {
"type": "string",
"nullable": true
},
"defaultDeliveryPlaceName": {
"type": "string",
"nullable": true
},
"deliveryPortNo": {
"type": "string",
"nullable": true
},
"deliveryPortName": {
"type": "string",
"nullable": true
},
"standardTextNo": {
"type": "string",
"nullable": true
},
"standardTextName": {
"type": "string",
"nullable": true
},
"requestForQuoteForwardType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SupplierForwardType"
},
"requestForQuoteForwardTypeValue": {
"type": "string",
"nullable": true
},
"purchaseOrderForwardType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SupplierPurchaseOrderForwardType"
},
"purchaseOrderForwardTypeValue": {
"type": "string",
"nullable": true
},
"productDescription": {
"type": "string",
"nullable": true
},
"csrNo": {
"type": "string",
"nullable": true
},
"csrName": {
"type": "string",
"nullable": true
},
"csrProductGroupNo": {
"type": "string",
"nullable": true
},
"csrProductGroupName": {
"type": "string",
"nullable": true
},
"hasContactWithConnectLogin": {
"type": "boolean"
},
"punchOutAvailable": {
"type": "boolean"
},
"itemTypesAsString": {
"type": "string",
"nullable": true
},
"itemTypeNamesAsString": {
"type": "string",
"nullable": true
},
"addressClassificationNo": {
"type": "string",
"nullable": true
},
"addressClassificationName": {
"type": "string",
"nullable": true
},
"addressClassificationAction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AddressClassificationAction"
},
"sendReminder": {
"type": "boolean"
},
"rfQsTotal": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rfQsRejected": {
"type": "integer",
"format": "int32",
"nullable": true
},
"pOsTotal": {
"type": "integer",
"format": "int32",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastEvaluationReviewDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"addressEvaluations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressEvaluation"
},
"nullable": true
},
"addressAddressCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressAddressCategory"
},
"nullable": true
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressContact"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressDocument"
},
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressUnit"
},
"nullable": true
},
"deliveryCosts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressDeliveryCost"
},
"nullable": true
},
"alternatePayers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressAlternatePayer"
},
"nullable": true
},
"punchOuts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressPunchOut"
},
"nullable": true
},
"itemTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AddressBook.AddressItemType"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressAddressCategory": {
"type": "object",
"properties": {
"addressNo": {
"type": "string",
"nullable": true
},
"addressName": {
"type": "string",
"nullable": true
},
"addressCategoryNo": {
"type": "string",
"nullable": true
},
"addressCategoryName": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressAlternatePayer": {
"type": "object",
"properties": {
"addressNo": {
"type": "string",
"nullable": true
},
"addressName": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressCategory": {
"type": "object",
"properties": {
"addressCategoryName": {
"type": "string",
"nullable": true
},
"addressCategoryNo": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressContact": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"mobile": {
"type": "string",
"nullable": true
},
"areaOfResponsibility": {
"type": "string",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
},
"inductedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"addressGuid": {
"type": "string",
"format": "uuid"
},
"addressNo": {
"type": "string",
"nullable": true
},
"addressName": {
"type": "string",
"nullable": true
},
"connectLogin": {
"type": "string",
"nullable": true
},
"connectPasswordExpireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"connectLockedUntilDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"hasConnectPassword": {
"type": "boolean"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressDeliveryCost": {
"type": "object",
"properties": {
"addressNo": {
"type": "string",
"nullable": true
},
"addressName": {
"type": "string",
"nullable": true
},
"deliveryCostNo": {
"type": "string",
"nullable": true
},
"deliveryCostName": {
"type": "string",
"nullable": true
},
"defaultAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"poValueLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressDocument": {
"type": "object",
"properties": {
"addressNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressEvaluation": {
"type": "object",
"properties": {
"addressName": {
"type": "string",
"nullable": true
},
"addressNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationAnswerName": {
"type": "string",
"nullable": true
},
"evaluationAnswerNo": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"groupId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"addressGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressItemType": {
"type": "object",
"properties": {
"addressNo": {
"type": "string",
"nullable": true
},
"addressName": {
"type": "string",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"itemTypeName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressPunchOut": {
"type": "object",
"properties": {
"addressNo": {
"type": "string",
"nullable": true
},
"addressName": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"supplierId": {
"type": "string",
"nullable": true
},
"clientId": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"authUrl": {
"type": "string",
"nullable": true
},
"authPost": {
"type": "string",
"nullable": true
},
"punchOutId": {
"type": "string",
"nullable": true
},
"punchOutToken": {
"type": "string",
"nullable": true
},
"punchOutType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PunchOutType"
},
"rePunchOut": {
"type": "boolean",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressResponse": {
"type": "object",
"properties": {
"addressNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AddressBook.AddressTypeSearchFlag": {
"enum": [
"All",
"Supplier",
"DeliveryPlace",
"InvoiceAddress",
"ShipYard",
"SurveyOrganization",
"Agent",
"Unit",
"Manufacturer",
"CertificateAuthority",
"Customer",
"Office",
"Contractor"
],
"type": "string"
},
"SerticaWebApi.Models.AddressBook.AddressUnit": {
"type": "object",
"properties": {
"addressNo": {
"type": "string",
"nullable": true
},
"addressName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AiClient.AiChatHistory": {
"type": "object",
"properties": {
"role": {
"type": "string",
"nullable": true
},
"content": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AiClient.AiClientAskModel": {
"type": "object",
"properties": {
"question": {
"type": "string",
"nullable": true
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AiClient.AiChatHistory"
},
"nullable": true
},
"unitNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AiClient.AiClientAskResponseModel": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
},
"answer": {
"type": "string",
"nullable": true
},
"talkId": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.AiClient.AiClientDocumentModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.AiClient.AiClientDocumentModel": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"unitNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsCustomMenu": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"parentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"parentAnalyticsCustomMenuGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"parentAnalyticsMenuGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"menuNo": {
"type": "string",
"nullable": true
},
"menuType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuType"
},
"childItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomMenu"
},
"nullable": true
},
"deleted": {
"type": "boolean"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate": {
"type": "object",
"properties": {
"templateType": {
"$ref": "#/components/schemas/Logimatic.Analytics.Component.Model.TemplateType"
},
"templateNo": {
"type": "string",
"nullable": true
},
"viewName": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"templateFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateField"
},
"nullable": true
},
"drilldownScreen": {
"type": "string",
"nullable": true
},
"drilldownTypeName": {
"type": "string",
"nullable": true
},
"menuNo": {
"type": "string",
"nullable": true
},
"menuName": {
"type": "string",
"nullable": true
},
"menuGuid": {
"type": "string",
"format": "uuid"
},
"analyticsCustomMenuGuid": {
"type": "string",
"nullable": true
},
"ownerUserNo": {
"type": "string",
"nullable": true
},
"ownerUserName": {
"type": "string",
"nullable": true
},
"formTemplateGuid": {
"type": "string",
"format": "uuid"
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"formTemplateTableNo": {
"type": "string",
"nullable": true
},
"formTemplateTableName": {
"type": "string",
"nullable": true
},
"viewScript": {
"type": "string",
"nullable": true
},
"availableTo": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AnalyticsTemplateAvailableTo"
},
"jobRequestTemplateGuid": {
"type": "string",
"format": "uuid"
},
"jobRequestTemplateNo": {
"type": "string",
"nullable": true
},
"jobRequestTemplateTitle": {
"type": "string",
"nullable": true
},
"jobRequestTemplateUnitNo": {
"type": "string",
"nullable": true
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateResource"
},
"nullable": true
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateRole"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateField": {
"type": "object",
"properties": {
"analyticsCustomTemplateGuid": {
"type": "string",
"format": "uuid"
},
"fieldName": {
"type": "string",
"nullable": true
},
"displayType": {
"$ref": "#/components/schemas/Logimatic.Analytics.Component.Model.TemplateFieldDisplayType"
},
"displayTypeFilterText": {
"$ref": "#/components/schemas/Logimatic.Analytics.Component.Model.TemplateFieldDisplayType"
},
"templateNo": {
"type": "string",
"nullable": true
},
"templateName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateResource": {
"type": "object",
"properties": {
"templateNo": {
"type": "string",
"nullable": true
},
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateRole": {
"type": "object",
"properties": {
"templateNo": {
"type": "string",
"nullable": true
},
"roleNo": {
"type": "string",
"nullable": true
},
"roleName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsCustomTemplateScanViewResult": {
"type": "object",
"properties": {
"addedFields": {
"type": "integer",
"format": "int32"
},
"removedFields": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsMenuItem": {
"type": "object",
"properties": {
"parentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"menuNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"menuType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuType"
},
"childItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsMenuType": {
"enum": [
"Default",
"Menu",
"CustomMenu",
"UserMenu",
"Template",
"CustomTemplate",
"Report",
"DataWarehouseTemplate"
],
"type": "string"
},
"SerticaWebApi.Models.Analytics.AnalyticsReport": {
"type": "object",
"properties": {
"sheetInDocument": {
"type": "string",
"nullable": true
},
"dataRange": {
"type": "string",
"nullable": true
},
"reportOutputFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportOutputField"
},
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"reportNo": {
"type": "string",
"nullable": true
},
"dataSet": {
"nullable": true
},
"reportOutputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportOutput"
},
"nullable": true
},
"reportFilterFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterField"
},
"nullable": true
},
"userMenuGuid": {
"type": "string",
"nullable": true
},
"userMenuNo": {
"type": "string",
"nullable": true
},
"templateNo": {
"type": "string",
"nullable": true
},
"templateNameTextID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"templateName": {
"type": "string",
"nullable": true
},
"templateType": {
"$ref": "#/components/schemas/Logimatic.Analytics.Component.Model.TemplateType"
},
"ownerUserNo": {
"type": "string",
"nullable": true
},
"ownerUserName": {
"type": "string",
"nullable": true
},
"excelTemplateNo": {
"type": "string",
"nullable": true
},
"excelTemplateDescription": {
"type": "string",
"nullable": true
},
"distinct": {
"type": "boolean"
},
"hasDataWarehouseTemplate": {
"type": "boolean",
"nullable": true
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportResource"
},
"nullable": true
},
"subReports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportSubReport"
},
"nullable": true
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsReportOutputField": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"format": "int32",
"nullable": true
},
"width": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfDecimals": {
"type": "integer",
"format": "int32",
"nullable": true
},
"skipThousandsSeparator": {
"type": "boolean",
"nullable": true
},
"displayType": {
"$ref": "#/components/schemas/Logimatic.Analytics.Component.Model.TemplateFieldDisplayType"
},
"analyticsTemplateFieldGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsReportResource": {
"type": "object",
"properties": {
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"analyticsReportGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"reportNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsSubscription": {
"type": "object",
"properties": {
"analyticsReportGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"reportNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"frequency": {
"type": "integer",
"format": "int32",
"nullable": true
},
"exportFolderPath": {
"type": "string",
"nullable": true
},
"mailingList": {
"type": "string",
"nullable": true
},
"intervalType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscriptionIntervalType"
},
"doNotSendEmptyReports": {
"type": "boolean",
"nullable": true
},
"mailSubject": {
"type": "string",
"nullable": true
},
"mailBody": {
"type": "string",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"runTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"recipientEmailsAsString": {
"type": "string",
"nullable": true
},
"scheduledExecutionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscriptionRecipient"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsSubscriptionIntervalType": {
"enum": [
"Months",
"Days",
"SpecificTimes"
],
"type": "string"
},
"SerticaWebApi.Models.Analytics.AnalyticsSubscriptionRecipient": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"userEmail": {
"type": "string",
"nullable": true
},
"analyticsSubscriptionGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsTemplate": {
"type": "object",
"properties": {
"templateType": {
"$ref": "#/components/schemas/Logimatic.Analytics.Component.Model.TemplateType"
},
"templateNo": {
"type": "string",
"nullable": true
},
"viewName": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"expired": {
"type": "boolean",
"readOnly": true
},
"expireDescription": {
"type": "string",
"nullable": true
},
"templateFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"drilldownScreen": {
"type": "string",
"nullable": true
},
"drilldownTypeName": {
"type": "string",
"nullable": true
},
"availableTo": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AnalyticsTemplateAvailableTo"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateResource"
},
"nullable": true
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateRole"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsTemplateField": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"templateGuid": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"fieldName": {
"type": "string",
"nullable": true
},
"translatedNameByOutputLanguage": {
"type": "string",
"nullable": true
},
"displayType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsTemplateFieldDisplayType"
},
"outputLanguage": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsLanguage"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsTemplateResource": {
"type": "object",
"properties": {
"templateNo": {
"type": "string",
"nullable": true
},
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsTemplateRole": {
"type": "object",
"properties": {
"templateNo": {
"type": "string",
"nullable": true
},
"roleNo": {
"type": "string",
"nullable": true
},
"roleName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.AnalyticsUserMenu": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"parentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"parentUserMenuNo": {
"type": "string",
"nullable": true
},
"menuNo": {
"type": "string",
"nullable": true
},
"menuType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuType"
},
"childItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsUserMenu"
},
"nullable": true
},
"deleted": {
"type": "boolean"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplate": {
"type": "object",
"properties": {
"templateNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"exportFrequency": {
"type": "integer",
"format": "int32",
"nullable": true
},
"exportFrequencyRecurrence": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataWarehouseExportFrequencyRecurrence"
},
"exportDataPersistence": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataWarehouseDataPersistence"
},
"lastSuccessfulRun": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nextRun": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lockedByUserNo": {
"type": "string",
"nullable": true
},
"lockedByUserName": {
"type": "string",
"nullable": true
},
"locked": {
"type": "boolean"
},
"ownerUserNo": {
"type": "string",
"nullable": true
},
"ownerUserName": {
"type": "string",
"nullable": true
},
"reportNo": {
"type": "string",
"nullable": true
},
"reportDescription": {
"type": "string",
"nullable": true
},
"connectionNo": {
"type": "string",
"nullable": true
},
"connectionName": {
"type": "string",
"nullable": true
},
"menuNo": {
"type": "string",
"nullable": true
},
"availableTo": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AnalyticsTemplateAvailableTo"
},
"menuName": {
"type": "string",
"nullable": true
},
"menuGuid": {
"type": "string",
"format": "uuid"
},
"drilldownScreen": {
"type": "string",
"nullable": true
},
"drilldownTypeName": {
"type": "string",
"nullable": true
},
"enableDrilldown": {
"type": "boolean",
"nullable": true
},
"customMenuGuid": {
"type": "string",
"nullable": true
},
"templateType": {
"$ref": "#/components/schemas/Logimatic.Analytics.Component.Model.TemplateType"
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateTsTask"
},
"nullable": true
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateResource"
},
"nullable": true
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateRole"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateResource": {
"type": "object",
"properties": {
"templateNo": {
"type": "string",
"nullable": true
},
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"isUser": {
"type": "boolean"
},
"isUserGroup": {
"type": "boolean"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateRole": {
"type": "object",
"properties": {
"templateNo": {
"type": "string",
"nullable": true
},
"roleNo": {
"type": "string",
"nullable": true
},
"roleName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseAnalyticsTemplateTsTask": {
"type": "object",
"properties": {
"templateNo": {
"type": "string",
"nullable": true
},
"taskNo": {
"type": "string",
"nullable": true
},
"dataWarehouseAnalyticsTemplateGuid": {
"type": "string",
"format": "uuid"
},
"activated": {
"type": "boolean",
"nullable": true
},
"taskStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TaskStatus"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.DataWarehouse.DataWarehouseConnection": {
"type": "object",
"properties": {
"connectionNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"serverInstance": {
"type": "string",
"nullable": true
},
"database": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"connectionType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataWarehouseConnectionType"
},
"maintenanceMode": {
"type": "boolean",
"nullable": true
},
"connectionString": {
"type": "string",
"nullable": true
},
"hasPassword": {
"type": "boolean"
},
"password": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.Report.AnalyticsComparison": {
"enum": [
"None",
"SmallerThan",
"Equal",
"GreaterThan"
],
"type": "string"
},
"SerticaWebApi.Models.Analytics.Report.AnalyticsLanguage": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterField": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"summarize": {
"type": "boolean",
"nullable": true
},
"compareToTemplateFieldName": {
"type": "string",
"nullable": true
},
"compareToCustomTemplateFieldName": {
"type": "string",
"nullable": true
},
"reportFilterRangeFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterRange"
},
"nullable": true
},
"dynamicDateValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"dynamicDateDirection": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterFieldDynamicDateDirection"
},
"dynamicDateType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterFieldDynamicDateType"
},
"displayType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsTemplateFieldDisplayType"
},
"applyFilteringToDistinctList": {
"type": "boolean"
},
"emptyValuesOnly": {
"type": "boolean",
"nullable": true
},
"booleanValue": {
"type": "boolean",
"nullable": true
},
"dateTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"staticDateRangeStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"staticDateRangeDateDynamic": {
"type": "boolean",
"nullable": true
},
"topValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"timeComparisonOperator": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsTimeComparison"
},
"numberTo": {
"type": "number",
"format": "double",
"nullable": true
},
"numberFrom": {
"type": "number",
"format": "double",
"nullable": true
},
"textLike": {
"type": "string",
"nullable": true
},
"textTo": {
"type": "string",
"nullable": true
},
"textFrom": {
"type": "string",
"nullable": true
},
"queryGuid": {
"type": "string",
"nullable": true
},
"excludeInOutput": {
"type": "boolean",
"nullable": true
},
"excludeFromList": {
"type": "boolean",
"nullable": true
},
"aggregationType": {
"$ref": "#/components/schemas/Logimatic.Analytics.Component.Model.AggregationType"
},
"templateFieldName": {
"type": "string",
"nullable": true
},
"customTemplateFieldName": {
"type": "string",
"nullable": true
},
"comparisonOperator": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsComparison"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortType": {
"$ref": "#/components/schemas/Logimatic.Analytics.Component.Model.SortingType"
},
"deleted": {
"type": "boolean"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterFieldDynamicDateDirection": {
"enum": [
"Last",
"Next"
],
"type": "string"
},
"SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterFieldDynamicDateType": {
"enum": [
"Days",
"Weeks",
"WholeWeeks",
"Months",
"WholeMonths",
"Quarter",
"PresentQuarter",
"Year",
"WholeYear",
"YearToDate",
"PresentDay",
"PresentWeek",
"PresentMonth",
"PresentYear",
"WholeDays"
],
"type": "string"
},
"SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterRange": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"reportFilterFieldGuid": {
"type": "string",
"nullable": true
},
"textRangeValue": {
"type": "string",
"nullable": true
},
"dateRangeValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.Report.AnalyticsReportOutput": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"nullable": true
},
"reportGuid": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.Report.AnalyticsReportSubReport": {
"type": "object",
"properties": {
"parentReportNo": {
"type": "string",
"nullable": true
},
"reportNo": {
"type": "string",
"nullable": true
},
"reportDescription": {
"type": "string",
"nullable": true
},
"sheetInDocument": {
"type": "string",
"nullable": true
},
"dataRange": {
"type": "string",
"nullable": true
},
"subReport": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Analytics.Report.AnalyticsTemplateFieldDisplayType": {
"enum": [
"NumericFromTo",
"DateRange",
"DateDistinctList",
"DateDistinctFilteredList",
"TextLike",
"TextRange",
"TextDistinctList",
"TextDistinctFilteredList",
"SumDefault",
"Boolean",
"DateDynamic",
"Comparison",
"TextEmptyValues",
"DateEmptyValues",
"NumericEmptyValues",
"PrimaryKey",
"UnitGuid",
"SystemFilterColumn"
],
"type": "string"
},
"SerticaWebApi.Models.Analytics.Report.AnalyticsTimeComparison": {
"enum": [
"None",
"Today",
"CurrentMonth",
"CurrentYear"
],
"type": "string"
},
"SerticaWebApi.Models.ApiCombinePositionArguments": {
"type": "object",
"properties": {
"requisitionNo": {
"type": "string",
"nullable": true
},
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ApiMail": {
"type": "object",
"properties": {
"recipient": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"documentsToAttach": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMailAttachment"
},
"nullable": true
},
"sendCopy": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ApiMailAttachment": {
"type": "object",
"properties": {
"documentNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ApprovalWebExcludedUnit.ApprovalWebExcludedUnit": {
"type": "object",
"properties": {
"referencedUnitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.BatchEdit.BatchEdit": {
"type": "object",
"properties": {
"objectType": {
"type": "string",
"nullable": true
},
"recordNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"transformations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditTransformation"
},
"nullable": true
},
"enabledTransformations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditTransformation"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations": {
"type": "object",
"properties": {
"transformations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditTransformation"
},
"nullable": true
},
"enabledTransformations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditTransformation"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.BatchEdit.BatchEditOperation": {
"enum": [
"Add",
"Replace",
"Remove",
"Clear"
],
"type": "string"
},
"SerticaWebApi.Models.BatchEdit.BatchEditRecordResult": {
"type": "object",
"properties": {
"objectNo": {
"type": "string",
"nullable": true
},
"state": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditResultState"
},
"result": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.BatchEdit.BatchEditResult": {
"type": "object",
"properties": {
"recordResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditRecordResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.BatchEdit.BatchEditResultState": {
"enum": [
"Updated",
"Skipped",
"Failed"
],
"type": "string"
},
"SerticaWebApi.Models.BatchEdit.BatchEditTransformation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"field": {
"type": "string",
"nullable": true
},
"operation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BatchEdit.BatchEditOperation"
},
"newObjectNo": {
"type": "string",
"nullable": true
},
"oldObjectNo": {
"type": "string",
"nullable": true
},
"newObjectNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"keepManHours": {
"type": "boolean"
},
"keepExternalCost": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.BrokenRule": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BrokenRuleType"
},
"index": {
"type": "integer",
"format": "int32",
"nullable": true
},
"objectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"field": {
"type": "string",
"nullable": true
},
"field2": {
"type": "string",
"nullable": true
},
"field3": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.BrokenRuleType": {
"enum": [
"Default",
"ShouldBeFilled",
"Information",
"Warning",
"Error",
"Delete"
],
"type": "string"
},
"SerticaWebApi.Models.Budget.Budget": {
"type": "object",
"properties": {
"budgetNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementBudgetStatus"
},
"budgetPeriodNo": {
"type": "string",
"nullable": true
},
"budgetPeriodName": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"budgetTemplateNo": {
"type": "string",
"nullable": true
},
"budgetTemplateName": {
"type": "string",
"nullable": true
},
"responsibleNo": {
"type": "string",
"nullable": true
},
"responsibleName": {
"type": "string",
"nullable": true
},
"unitLeadNo": {
"type": "string",
"nullable": true
},
"unitLeadName": {
"type": "string",
"nullable": true
},
"companyLeadNo": {
"type": "string",
"nullable": true
},
"companyLeadName": {
"type": "string",
"nullable": true
},
"monetaryUnit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"budgetLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetLine"
},
"nullable": true
},
"budgetApprovers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetApprover"
},
"nullable": true
},
"budgetResponses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Budget.BudgetResponse"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Budget.BudgetApprover": {
"type": "object",
"properties": {
"approvalOrder": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+BudgetModuleApproverStatus"
},
"approverNo": {
"type": "string",
"nullable": true
},
"approverName": {
"type": "string",
"nullable": true
},
"budgetNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Budget.BudgetLine": {
"type": "object",
"properties": {
"accountNo": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"technicalAccountNo": {
"type": "string",
"nullable": true
},
"technicalAccountName": {
"type": "string",
"nullable": true
},
"purchaseTypeNo": {
"type": "string",
"nullable": true
},
"purchaseTypeName": {
"type": "string",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"divisionNo": {
"type": "string",
"nullable": true
},
"divisionName": {
"type": "string",
"nullable": true
},
"icNo": {
"type": "string",
"nullable": true
},
"icName": {
"type": "string",
"nullable": true
},
"incidentNo": {
"type": "string",
"nullable": true
},
"incidentDescription": {
"type": "string",
"nullable": true
},
"marketProductNo": {
"type": "string",
"nullable": true
},
"marketProductName": {
"type": "string",
"nullable": true
},
"projectNo": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"projectCodeNo": {
"type": "string",
"nullable": true
},
"projectCodeName": {
"type": "string",
"nullable": true
},
"routeNo": {
"type": "string",
"nullable": true
},
"routeName": {
"type": "string",
"nullable": true
},
"sundryNo": {
"type": "string",
"nullable": true
},
"sundryName": {
"type": "string",
"nullable": true
},
"agentNo": {
"type": "string",
"nullable": true
},
"agentName": {
"type": "string",
"nullable": true
},
"areaSFINo": {
"type": "string",
"nullable": true
},
"areaSFIName": {
"type": "string",
"nullable": true
},
"subTypeNo": {
"type": "string",
"nullable": true
},
"subTypeName": {
"type": "string",
"nullable": true
},
"freeDimensionNo": {
"type": "string",
"nullable": true
},
"freeDimensionName": {
"type": "string",
"nullable": true
},
"manualNo": {
"type": "string",
"nullable": true
},
"manualName": {
"type": "string",
"nullable": true
},
"monthAmount1": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount2": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount3": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount4": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount5": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount6": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount7": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount8": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount9": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount10": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount11": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"monthAmount12": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"parentLineGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"budgetNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Budget.BudgetResponse": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"acknowledgedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"recipientNo": {
"type": "string",
"nullable": true
},
"recipientName": {
"type": "string",
"nullable": true
},
"acknowledgedByNo": {
"type": "string",
"nullable": true
},
"acknowledgedByName": {
"type": "string",
"nullable": true
},
"budgetNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.BudgetAccrualExport.BudgetAccrualExport": {
"type": "object",
"properties": {
"accrualExportNo": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"accrualPeriod": {
"type": "string",
"format": "date-time",
"nullable": true
},
"accrualTotalAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"reversalPeriod": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reversalTotalAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"exported": {
"type": "boolean",
"nullable": true
},
"exportedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CalculatePurchaseOrder.ApiCalculatePOSaveResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.CalculatePOSaveResultIssue"
},
"nullable": true
},
"createdPurchaseOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOCreateArguments": {
"type": "object",
"properties": {
"no": {
"type": "string",
"nullable": true
},
"calculatePOType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.CalculatePOTypes"
},
"fromSingleSupplier": {
"type": "boolean"
},
"createSharedUnitPO": {
"type": "boolean"
},
"acceptPositionSuppliers": {
"type": "boolean"
},
"rejectRemainingQuotes": {
"type": "boolean"
},
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.PurchaseOrderPreview"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOPort": {
"type": "object",
"properties": {
"isQuotedPort": {
"type": "boolean"
},
"isCatalogPort": {
"type": "boolean"
},
"portCodeNo": {
"type": "string",
"nullable": true
},
"portName": {
"type": "string",
"nullable": true
},
"deliveryPlaceNo": {
"type": "string",
"nullable": true
},
"deliveryPlaceName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOPosition": {
"type": "object",
"properties": {
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"positionName": {
"type": "string",
"nullable": true
},
"mainObjectNo": {
"type": "string",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"discount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalPrice": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"totalPriceStdCurrency": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"deliveryDays": {
"type": "number",
"format": "double",
"nullable": true
},
"allowThirdPartyItem": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePOSupplier": {
"type": "object",
"properties": {
"isQuotedSupplier": {
"type": "boolean",
"nullable": true
},
"isCatalogSupplier": {
"type": "boolean",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"availableSparePartSuppliers": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CalculatePurchaseOrder.CalculatePurchaseOrderArguments": {
"type": "object",
"properties": {
"no": {
"type": "string",
"nullable": true
},
"calculatePOType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.CalculatePO.CalculatePOTypes"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.Certificate": {
"type": "object",
"properties": {
"certificateNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"certificateGroupGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"certificateGroupId": {
"type": "string",
"nullable": true
},
"certificateGroupNo": {
"type": "string",
"nullable": true
},
"certificateGroupName": {
"type": "string",
"nullable": true
},
"certificateLocationNo": {
"type": "string",
"nullable": true
},
"certificateLocationName": {
"type": "string",
"nullable": true
},
"documentPreviewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"documentFileName": {
"type": "string",
"nullable": true
},
"documentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"issuedByNo": {
"type": "string",
"nullable": true
},
"issuedByName": {
"type": "string",
"nullable": true
},
"serialNo": {
"type": "string",
"nullable": true
},
"additionalComments": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateStatus"
},
"officialNo": {
"type": "string",
"nullable": true
},
"issueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastVerificationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nextVerificationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"verification1Date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"verification2Date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"verification3Date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"verification4Date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"verification5Date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"verification6Date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"responsibleNo": {
"type": "string",
"nullable": true
},
"responsibleName": {
"type": "string",
"nullable": true
},
"responsibleType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"remark": {
"type": "string",
"nullable": true
},
"overdue": {
"type": "boolean",
"nullable": true
},
"due": {
"type": "boolean",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateDocument"
},
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateResponse"
},
"nullable": true
},
"notificationSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateCertificateNotificationSetting"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateCertificateNotificationSetting": {
"type": "object",
"properties": {
"certificateGuid": {
"type": "string",
"format": "uuid"
},
"certificateNotificationSettingNo": {
"type": "string",
"nullable": true
},
"certificateNotificationSettingName": {
"type": "string",
"nullable": true
},
"certificateNo": {
"type": "string",
"nullable": true
},
"certificateName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateDocument": {
"type": "object",
"properties": {
"certificateNo": {
"type": "string",
"nullable": true
},
"certificateName": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateGroup": {
"type": "object",
"properties": {
"certificateGroupNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"groupID": {
"type": "string",
"nullable": true
},
"parentGroupID": {
"type": "string",
"nullable": true
},
"parentGroupNo": {
"type": "string",
"nullable": true
},
"parentGroupName": {
"type": "string",
"nullable": true
},
"defaultResponsibleNo": {
"type": "string",
"nullable": true
},
"defaultResponsibleName": {
"type": "string",
"nullable": true
},
"defaultResponsibleType": {
"type": "string",
"nullable": true
},
"certificateGroupRuleNo": {
"type": "string",
"nullable": true
},
"certificateGroupRuleName": {
"type": "string",
"nullable": true
},
"certificateLocationNo": {
"type": "string",
"nullable": true
},
"certificateLocationName": {
"type": "string",
"nullable": true
},
"daysAfterAnnualDate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"daysAfterExpireDate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"daysAfterIntermediateDate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"daysAfterPeriodicalDate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"daysAfterVerificationDate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"annualDurationDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"expireDurationDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"intermediateDurationDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"periodicalDurationDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"verificationDurationDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"doNotAllowRenewOnUnit": {
"type": "boolean",
"nullable": true
},
"vesselTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateGroupVesselType"
},
"nullable": true
},
"notificationSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateCertificateNotificationSetting"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateGroupRule": {
"type": "object",
"properties": {
"certificateGroupRuleNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"issueDateRule": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule"
},
"expireDateRule": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule"
},
"lastVerificationDateRule": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule"
},
"nextVerificationDateRule": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule"
},
"firstVerificationDateRule": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule"
},
"firstVerificationDateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleVerificationType"
},
"secondVerificationDateRule": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule"
},
"secondVerificationDateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleVerificationType"
},
"thirdVerificationDateRule": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule"
},
"thirdVerificationDateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleVerificationType"
},
"fourthVerificationDateRule": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule"
},
"fourthVerificationDateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleVerificationType"
},
"fifthVerificationDateRule": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule"
},
"fifthVerificationDateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleVerificationType"
},
"sixthVerificationDateRule": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleFieldRule"
},
"sixthVerificationDateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CertificateGroupRuleVerificationType"
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateGroupVesselType": {
"type": "object",
"properties": {
"certificateGroupID": {
"type": "string",
"nullable": true
},
"certificateGroupNo": {
"type": "string",
"nullable": true
},
"certificateGroupName": {
"type": "string",
"nullable": true
},
"vesselTypeNo": {
"type": "string",
"nullable": true
},
"vesselTypeName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateLocation": {
"type": "object",
"properties": {
"certificateLocationNo": {
"type": "string",
"nullable": true
},
"certificateLocationName": {
"type": "string",
"nullable": true
},
"certificateGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateLocationCertificateGroup"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateLocationCertificateGroup": {
"type": "object",
"properties": {
"certificateLocationNo": {
"type": "string",
"nullable": true
},
"certificateLocationName": {
"type": "string",
"nullable": true
},
"certificateGroupID": {
"type": "string",
"nullable": true
},
"certificateGroupNo": {
"type": "string",
"nullable": true
},
"certificateGroupName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateMail": {
"type": "object",
"properties": {
"recipients": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"sendCopy": {
"type": "boolean"
},
"attachedCertificates": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateNotificationSetting": {
"type": "object",
"properties": {
"certificateNotificationSettingNo": {
"type": "string",
"nullable": true
},
"certificateNotificationSettingName": {
"type": "string",
"nullable": true
},
"notificationDays": {
"type": "integer",
"format": "int32"
},
"active": {
"type": "boolean"
},
"sendEmail": {
"type": "boolean"
},
"repeatNotification": {
"type": "boolean"
},
"emailSubjectNo": {
"type": "string",
"nullable": true
},
"emailSubjectName": {
"type": "string",
"nullable": true
},
"emailBodyNo": {
"type": "string",
"nullable": true
},
"emailBodyName": {
"type": "string",
"nullable": true
},
"certificateGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateNotificationSettingCertificateGroup": {
"type": "object",
"properties": {
"certificateGroupID": {
"type": "string",
"nullable": true
},
"certificateGroupNo": {
"type": "string",
"nullable": true
},
"certificateGroupName": {
"type": "string",
"nullable": true
},
"certificateNotificationSettingNo": {
"type": "string",
"nullable": true
},
"certificateNotificationSettingName": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateResponse": {
"type": "object",
"properties": {
"certificateGuid": {
"type": "string",
"format": "uuid"
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateTreeNode": {
"type": "object",
"properties": {
"hasChildren": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"visibleKey": {
"type": "string",
"nullable": true
},
"alias": {
"type": "string",
"nullable": true
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateTreeNodeType"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Certificate.CertificateTreeNode"
},
"nullable": true
},
"certificateCount": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Certificate.CertificateTreeNodeType": {
"enum": [
"CertificateGroup",
"Certificate",
"Obsolete",
"Overdue",
"Due"
],
"type": "string"
},
"SerticaWebApi.Models.ChangeRequestApprover": {
"type": "object",
"properties": {
"changeRequestNo": {
"type": "string",
"nullable": true
},
"approverNo": {
"type": "string",
"nullable": true
},
"approverName": {
"type": "string",
"nullable": true
},
"approvalOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ChangeRequestUnit": {
"type": "object",
"properties": {
"changeRequestNo": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"addUnit": {
"type": "boolean"
},
"removeUnit": {
"type": "boolean"
},
"existsOnDocument": {
"type": "boolean"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ClassCode.ClassCode": {
"type": "object",
"properties": {
"classCodeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Company.Company": {
"type": "object",
"properties": {
"companyNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"addressLine": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"zipCode": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"telefax": {
"type": "string",
"nullable": true
},
"countryCodeNo": {
"type": "string",
"nullable": true
},
"countryCodeName": {
"type": "string",
"nullable": true
},
"unitNos": {
"type": "string",
"nullable": true
},
"unitNames": {
"type": "string",
"nullable": true
},
"approvalRequired": {
"type": "boolean",
"nullable": true
},
"purchaseOrderMustBePriced": {
"type": "boolean",
"nullable": true
},
"purchaserAndApproverDifferent": {
"type": "boolean",
"nullable": true
},
"invoiceResponsibleAndApproverDifferent": {
"type": "boolean",
"nullable": true
},
"requisitionMustBePriced": {
"type": "boolean",
"nullable": true
},
"approvalLimit": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"companyApprovalType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CompanyApprovalType"
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyCombinedUserRole2"
},
"nullable": true
},
"approvalSetupDimensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetupDimension"
},
"nullable": true
},
"approvalSetups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetup"
},
"nullable": true
},
"automaticReminders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyAutomaticReminder"
},
"nullable": true
},
"approvalDimensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyAccountingDimension"
},
"nullable": true
},
"companyApprovalSetupAccountingDimensionRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyApprovalSetupAccountingDimensionRule"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Company.CompanyAccountingDimension": {
"type": "object",
"properties": {
"accountingDimensionNo": {
"type": "string",
"nullable": true
},
"accountingDimensionName": {
"type": "string",
"nullable": true
},
"dimensionOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Company.CompanyApprovalSetup": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"approvalSetupUnitNo": {
"type": "string",
"nullable": true
},
"approvalSetupUnitName": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"approvalSetupNo": {
"type": "string",
"nullable": true
},
"approvalSetupName": {
"type": "string",
"nullable": true
},
"technicalAccountNo": {
"type": "string",
"nullable": true
},
"technicalAccountName": {
"type": "string",
"nullable": true
},
"purchaseTypeNo": {
"type": "string",
"nullable": true
},
"purchaseTypeName": {
"type": "string",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"itemTypeName": {
"type": "string",
"nullable": true
},
"projectNo": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Company.CompanyApprovalSetupAccountingDimensionRule": {
"type": "object",
"properties": {
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"approvalSetupNo": {
"type": "string",
"nullable": true
},
"approvalSetupName": {
"type": "string",
"nullable": true
},
"dimensionValueConfiguration": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria"
},
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Company.CompanyApprovalSetupDimension": {
"type": "object",
"properties": {
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"dimensionType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ApprovalSetupDimensionType"
},
"order": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Company.CompanyAutomaticReminder": {
"type": "object",
"properties": {
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"automaticReminderNo": {
"type": "string",
"nullable": true
},
"autoReminderType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AutomaticReminderType"
},
"daysToRemind": {
"type": "integer",
"format": "int32"
},
"excludeWeekends": {
"type": "boolean"
},
"reminderSubject": {
"type": "string",
"nullable": true
},
"reminderSubjectName": {
"type": "string",
"nullable": true
},
"reminderBody": {
"type": "string",
"nullable": true
},
"reminderBodyName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Company.CompanyCombinedUserRole2": {
"type": "object",
"properties": {
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"approvalLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"singleApprovalLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"accountsAsString": {
"type": "string",
"nullable": true
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Company.CompanyCombinedUserRole2Account"
},
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Company.CompanyCombinedUserRole2Account": {
"type": "object",
"properties": {
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"approvalLimit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.Component": {
"type": "object",
"properties": {
"componentNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"componentTypeNo": {
"type": "string",
"nullable": true
},
"componentTypeName": {
"type": "string",
"nullable": true
},
"parentComponentNo": {
"type": "string",
"nullable": true
},
"parentComponentName": {
"type": "string",
"nullable": true
},
"locationNo": {
"type": "string",
"nullable": true
},
"locationName": {
"type": "string",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"installedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"criticalEquipment": {
"type": "boolean",
"nullable": true
},
"estimatedLifetime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sectionNo": {
"type": "string",
"nullable": true
},
"sectionName": {
"type": "string",
"nullable": true
},
"manufacturer": {
"type": "string",
"nullable": true
},
"manufacturerNo": {
"type": "string",
"nullable": true
},
"manufacturerName": {
"type": "string",
"nullable": true
},
"typeNo": {
"type": "string",
"nullable": true
},
"serialNo": {
"type": "string",
"nullable": true
},
"drawingNo": {
"type": "string",
"nullable": true
},
"classification": {
"type": "string",
"nullable": true
},
"systemNo": {
"type": "string",
"nullable": true
},
"technicalInfo": {
"type": "string",
"nullable": true
},
"purchaseYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createdYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"scrapYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"initialPrice": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"priceYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"disabled": {
"type": "boolean",
"nullable": true
},
"disabledDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"counterNo": {
"type": "string",
"nullable": true
},
"counterName": {
"type": "string",
"nullable": true
},
"componentCounterAverageChangePerDay": {
"type": "number",
"format": "double",
"nullable": true
},
"componentCounterLatestReading": {
"type": "number",
"format": "double",
"nullable": true
},
"componentCounterLatestReadingDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"componentCounterEstimatedNow": {
"type": "number",
"format": "double",
"nullable": true
},
"counterTypeNo": {
"type": "string",
"nullable": true
},
"counterTypeName": {
"type": "string",
"nullable": true
},
"counterTypeUnit": {
"type": "string",
"nullable": true
},
"componentNoStructure": {
"type": "string",
"nullable": true
},
"componentNameStructure": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"customProperties": {
"nullable": true
},
"gpsLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"gpsLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"qrCode": {
"type": "string",
"nullable": true
},
"copyCounterFromParent": {
"type": "boolean",
"nullable": true
},
"classCodeNo": {
"type": "string",
"nullable": true
},
"classCodeName": {
"type": "string",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"componentPhotoNo": {
"type": "string",
"nullable": true
},
"componentPhotoDescription": {
"type": "string",
"nullable": true
},
"webhookLogStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebhookLogStatus"
},
"defaultComponentNo": {
"type": "string",
"nullable": true
},
"masterComponentNo": {
"type": "string",
"nullable": true
},
"masterComponentName": {
"type": "string",
"nullable": true
},
"mdmMasterObjectGuid": {
"type": "string",
"format": "uuid"
},
"baseComponent": {
"type": "boolean"
},
"excludeFromJobUse": {
"type": "boolean"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentItem"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentDocument"
},
"nullable": true
},
"suppliers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentSupplier"
},
"nullable": true
},
"counterHistories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentCounterHistory"
},
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentResponse"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.ComponentCounterHistory": {
"type": "object",
"properties": {
"idSeq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"value": {
"type": "number",
"format": "double",
"nullable": true
},
"valueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reset": {
"type": "boolean"
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"counterTypeUnit": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.ComponentDocument": {
"type": "object",
"properties": {
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.ComponentItem": {
"type": "object",
"properties": {
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"drawingPosNo": {
"type": "string",
"nullable": true
},
"drawingPosRefNo": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"stock": {
"type": "number",
"format": "double",
"nullable": true
},
"componentUnitNo": {
"type": "string",
"nullable": true
},
"componentUnitName": {
"type": "string",
"nullable": true
},
"itemUnitNo": {
"type": "string",
"nullable": true
},
"itemUnitName": {
"type": "string",
"nullable": true
},
"componentNoStructure": {
"type": "string",
"nullable": true
},
"componentNameStructure": {
"type": "string",
"nullable": true
},
"masterDataClassNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.ComponentLocation": {
"type": "object",
"properties": {
"locationNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.ComponentMap": {
"type": "object",
"properties": {
"componentMapNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"frontPage": {
"type": "boolean"
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"hotspots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentMapHotspot"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.ComponentMapHotspot": {
"type": "object",
"properties": {
"hotspotNo": {
"type": "string",
"nullable": true
},
"positionX": {
"type": "number",
"format": "double"
},
"positionY": {
"type": "number",
"format": "double"
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"componentMapNo": {
"type": "string",
"nullable": true
},
"componentMapName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.ComponentResponse": {
"type": "object",
"properties": {
"componentGuid": {
"type": "string",
"format": "uuid"
},
"componentNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.ComponentRotateArguments": {
"type": "object",
"properties": {
"rotateComponentNo": {
"type": "string",
"nullable": true
},
"jobRelationsExistForComponentAccepted": {
"type": "boolean",
"nullable": true
},
"continueAccepted": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.ComponentSupplier": {
"type": "object",
"properties": {
"componentGuid": {
"type": "string",
"format": "uuid"
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"standardSupplier": {
"type": "boolean"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Component.ComponentType": {
"type": "object",
"properties": {
"componentTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Counter.Counter": {
"type": "object",
"properties": {
"counterNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"maxValue": {
"type": "number",
"format": "double",
"nullable": true
},
"manualReading": {
"type": "boolean",
"nullable": true
},
"readingFrequency": {
"type": "number",
"format": "double",
"nullable": true
},
"tagRef": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32",
"nullable": true
},
"averageChangePerDay": {
"type": "number",
"format": "double",
"nullable": true
},
"counterTypeNo": {
"type": "string",
"nullable": true
},
"counterTypeName": {
"type": "string",
"nullable": true
},
"counterTypeUnit": {
"type": "string",
"nullable": true
},
"counterTypeTrendDays": {
"type": "integer",
"format": "int64"
},
"latestReading": {
"type": "number",
"format": "double",
"nullable": true
},
"latestReadingDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estimatedNow": {
"type": "number",
"format": "double",
"nullable": true
},
"latestReadingRemark": {
"type": "string",
"nullable": true
},
"manualAveragePerDay": {
"type": "number",
"format": "double",
"nullable": true
},
"useManualAveragePerDay": {
"type": "boolean",
"nullable": true
},
"readings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Counter.CounterHistory"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Counter.CounterHistory": {
"type": "object",
"properties": {
"idSeq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"value": {
"type": "number",
"format": "double",
"nullable": true
},
"valueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"reset": {
"type": "boolean"
},
"counterNo": {
"type": "string",
"nullable": true
},
"counterName": {
"type": "string",
"nullable": true
},
"counterTypeUnit": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Counter.CounterType": {
"type": "object",
"properties": {
"counterTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"measuringUnit": {
"type": "string",
"nullable": true
},
"maxEventsPerDay": {
"type": "number",
"format": "double",
"nullable": true
},
"percentageAcceptableDeviation": {
"type": "number",
"format": "double",
"nullable": true
},
"trendDays": {
"type": "integer",
"format": "int32"
},
"resetAssociated": {
"type": "boolean",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CountryCode.CountryCode": {
"type": "object",
"properties": {
"countryCodeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Currency.Currency": {
"type": "object",
"properties": {
"currencyNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"exchangeRateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"decimalPlaces": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rateAmount": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"rates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Currency.CurrencyRate"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Currency.CurrencyRate": {
"type": "object",
"properties": {
"currencyNo": {
"type": "string",
"nullable": true
},
"rate": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"validFromDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CustomLayout.ScreenLayout": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"data": {
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate": {
"type": "object",
"properties": {
"screenLayout": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomLayout.ScreenLayout"
},
"propertyDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinition"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CustomProperties.PropertyDefinition": {
"type": "object",
"properties": {
"objectType": {
"type": "string",
"nullable": true
},
"displayName": {
"type": "string",
"nullable": true
},
"propertyName": {
"type": "string",
"nullable": true
},
"dataType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CustomProperties.PropertyDataType"
},
"skipThousandsSeparator": {
"type": "boolean",
"nullable": true
},
"required": {
"type": "boolean",
"nullable": true
},
"minLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"maxLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minIntValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"maxIntValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minDecimalValue": {
"type": "number",
"format": "double",
"nullable": true
},
"maxDecimalValue": {
"type": "number",
"format": "double",
"nullable": true
},
"minDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"maxDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"showTimeOnDate": {
"type": "boolean",
"nullable": true
},
"multiline": {
"type": "boolean",
"nullable": true
},
"listValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue"
},
"nullable": true
},
"fieldDependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionFieldDependency"
},
"nullable": true
},
"unitDependencies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.CustomProperties.PropertyDefinitionUnitDependency"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CustomProperties.PropertyDefinitionFieldDependency": {
"type": "object",
"properties": {
"mainObjectPropertyName": {
"type": "string",
"nullable": true
},
"referencedObjectPropertyName": {
"type": "string",
"nullable": true
},
"boolValue": {
"type": "boolean",
"nullable": true
},
"listValue": {
"type": "string",
"nullable": true
},
"dataType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CustomProperties.PropertyDataType"
},
"objectType": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"propertyDefinitionPropertyName": {
"type": "string",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.CustomProperties.PropertyDefinitionUnitDependency": {
"type": "object",
"properties": {
"mainObjectPropertyName": {
"type": "string",
"nullable": true
},
"referencedUnitNo": {
"type": "string",
"nullable": true
},
"referencedUnitName": {
"type": "string",
"nullable": true
},
"objectType": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.DeliveryCondition.DeliveryCondition": {
"type": "object",
"properties": {
"deliveryConditionNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"communicationLanguageNo": {
"type": "string",
"nullable": true
},
"communicationLanguageName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.DeliveryCost.DeliveryCost": {
"type": "object",
"properties": {
"deliveryCostNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"addDefault": {
"type": "boolean",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Department.Department": {
"type": "object",
"properties": {
"responsibleNo": {
"type": "string",
"nullable": true
},
"responsibleName": {
"type": "string",
"nullable": true
},
"parentDepartmentNo": {
"type": "string",
"nullable": true
},
"parentDepartmentName": {
"type": "string",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.Carrier": {
"type": "object",
"properties": {
"carrierNo": {
"type": "string",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderDescription": {
"type": "string",
"nullable": true
},
"purchaseOrderUrgent": {
"type": "boolean",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"totalValue": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"currencyNo": {
"type": "string",
"nullable": true
},
"totalWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"warehouseNo": {
"type": "string",
"nullable": true
},
"warehouseName": {
"type": "string",
"nullable": true
},
"endOfOrder": {
"type": "boolean",
"nullable": true
},
"purchaseOrderUnitNo": {
"type": "string",
"nullable": true
},
"purchaseOrderUnitName": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CarrierStatus"
},
"carrierUnitNo": {
"type": "string",
"nullable": true
},
"carrierUnitName": {
"type": "string",
"nullable": true
},
"dangerousGoods": {
"type": "boolean",
"nullable": true
},
"certificate": {
"type": "boolean",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"purchaseGroupNo": {
"type": "string",
"nullable": true
},
"purchaseGroupName": {
"type": "string",
"nullable": true
},
"shipmentNo": {
"type": "string",
"nullable": true
},
"shipmentDescription": {
"type": "string",
"nullable": true
},
"shipmentType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipmentType"
},
"expectedShipmentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalReference1": {
"type": "string",
"nullable": true
},
"externalReference2": {
"type": "string",
"nullable": true
},
"externalReference3": {
"type": "string",
"nullable": true
},
"externalReference4": {
"type": "string",
"nullable": true
},
"purchaseOrderUnitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPackage"
},
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierPosition"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierDocument"
},
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.CarrierResponse"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.CarrierDocument": {
"type": "object",
"properties": {
"carrierNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.CarrierPackage": {
"type": "object",
"properties": {
"numberOfPackages": {
"type": "integer",
"format": "int32",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"nullable": true
},
"length": {
"type": "number",
"format": "double",
"nullable": true
},
"width": {
"type": "number",
"format": "double",
"nullable": true
},
"height": {
"type": "number",
"format": "double",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"packingUnitNo": {
"type": "string",
"nullable": true
},
"packingUnitName": {
"type": "string",
"nullable": true
},
"carrierNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.CarrierPosition": {
"type": "object",
"properties": {
"listNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"transitReceivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"transitReceivedTotalQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"carrierPositionType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+CarrierPositionType"
},
"name": {
"type": "string",
"nullable": true
},
"dangerousGoods": {
"type": "boolean",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"itemUnitNo": {
"type": "string",
"nullable": true
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"measureUnitName": {
"type": "string",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true
},
"orderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"receivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"rejectedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"requestedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"certificate": {
"type": "boolean",
"nullable": true
},
"supplierItemNo": {
"type": "string",
"nullable": true
},
"purchaseOrderPositionGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.CarrierResponse": {
"type": "object",
"properties": {
"carrierNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.Destination": {
"type": "object",
"properties": {
"destinationNo": {
"type": "string",
"nullable": true
},
"destinationName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.PackingUnit": {
"type": "object",
"properties": {
"packingUnitNo": {
"type": "string",
"nullable": true
},
"packingUnitName": {
"type": "string",
"nullable": true
},
"length": {
"type": "number",
"format": "double",
"nullable": true
},
"width": {
"type": "number",
"format": "double",
"nullable": true
},
"height": {
"type": "number",
"format": "double",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.Shipment": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"shipmentType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipmentType"
},
"expectedShipmentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"shippedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"cancelledDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipmentStatus"
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true
},
"consigneeNo": {
"type": "string",
"nullable": true
},
"consigneeName": {
"type": "string",
"nullable": true
},
"freightForwarderNo": {
"type": "string",
"nullable": true
},
"freightForwarderName": {
"type": "string",
"nullable": true
},
"externalReference1": {
"type": "string",
"nullable": true
},
"externalReference2": {
"type": "string",
"nullable": true
},
"externalReference3": {
"type": "string",
"nullable": true
},
"externalReference4": {
"type": "string",
"nullable": true
},
"shippingCosts": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"portNo": {
"type": "string",
"nullable": true
},
"portName": {
"type": "string",
"nullable": true
},
"finalUnitNo": {
"type": "string",
"nullable": true
},
"finalUnitName": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"dangerousGoods": {
"type": "boolean",
"nullable": true
},
"certificate": {
"type": "boolean",
"nullable": true
},
"advised": {
"type": "boolean",
"nullable": true
},
"urgent": {
"type": "boolean",
"nullable": true
},
"purchaseOrders": {
"type": "string",
"nullable": true
},
"markings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentMarking"
},
"nullable": true
},
"unassignedCarriers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentCarrier"
},
"nullable": true
},
"pickupWarehouses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentPickupWarehouse"
},
"nullable": true
},
"destinationWarehouses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentDestinationWarehouse"
},
"nullable": true
},
"freightDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentFreightDetail"
},
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentResponse"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentDocument"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.ShipmentCarrier": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"carrierNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"totalWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"totalValue": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"dangerousGoods": {
"type": "boolean",
"nullable": true
},
"certificate": {
"type": "boolean",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"orderDescription": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.ShipmentDestinationWarehouse": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"warehouseNo": {
"type": "string",
"nullable": true
},
"warehouseName": {
"type": "string",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"received": {
"type": "boolean",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.ShipmentDocument": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.ShipmentFreightDetail": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"shipmentWayNo": {
"type": "string",
"nullable": true
},
"shipmentWayName": {
"type": "string",
"nullable": true
},
"placeOfDepartureNo": {
"type": "string",
"nullable": true
},
"placeOfDepartureName": {
"type": "string",
"nullable": true
},
"departureDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"placeOfArrivalNo": {
"type": "string",
"nullable": true
},
"placeOfArrivalName": {
"type": "string",
"nullable": true
},
"arrivalDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"trackingNumber": {
"type": "string",
"nullable": true
},
"airWayBillNo": {
"type": "string",
"nullable": true
},
"flightNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.ShipmentMailRecipientType": {
"enum": [
"Consignee",
"FreightForwarder"
],
"type": "string"
},
"SerticaWebApi.Models.Distribution.ShipmentMailRequest": {
"type": "object",
"properties": {
"recipient": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentMailRecipientType"
},
"reportDocumentNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"includeCarrierDocuments": {
"type": "boolean"
},
"includeLandingAdviceDocuments": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.ShipmentMarking": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"markingNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"picked": {
"type": "boolean",
"nullable": true
},
"netWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"grossWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"length": {
"type": "number",
"format": "double",
"nullable": true
},
"width": {
"type": "number",
"format": "double",
"nullable": true
},
"height": {
"type": "number",
"format": "double",
"nullable": true
},
"volume": {
"type": "number",
"format": "double",
"nullable": true
},
"value": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"carriers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.ShipmentMarkingCarrier"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.ShipmentMarkingCarrier": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"markingNo": {
"type": "string",
"nullable": true
},
"carrierNo": {
"type": "string",
"nullable": true
},
"picked": {
"type": "boolean",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"totalWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"totalValue": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"dangerousGoods": {
"type": "boolean",
"nullable": true
},
"certificate": {
"type": "boolean",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"orderDescription": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.ShipmentPickupWarehouse": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"warehouseNo": {
"type": "string",
"nullable": true
},
"warehouseName": {
"type": "string",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.ShipmentResponse": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.ShipmentWay": {
"type": "object",
"properties": {
"shipmentWayNo": {
"type": "string",
"nullable": true
},
"shipmentWayName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.UnitShipment": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"expectedShipmentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"shippedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"cancelledDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipmentStatus"
},
"shippingCosts": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"dangerousGoods": {
"type": "boolean",
"nullable": true
},
"certificate": {
"type": "boolean",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"warehouses": {
"type": "string",
"nullable": true
},
"externalReference1": {
"type": "string",
"nullable": true
},
"externalReference2": {
"type": "string",
"nullable": true
},
"externalReference3": {
"type": "string",
"nullable": true
},
"externalReference4": {
"type": "string",
"nullable": true
},
"markings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarking"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.UnitShipmentEvaluationItem": {
"type": "object",
"properties": {
"addressName": {
"type": "string",
"nullable": true
},
"addressNo": {
"type": "string",
"nullable": true
},
"objectNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationAnswerName": {
"type": "string",
"nullable": true
},
"evaluationAnswerNo": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"groupId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"evaluationStep": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+EvaluationProcess"
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"objectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.UnitShipmentMarking": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"markingNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"received": {
"type": "boolean"
},
"netWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"grossWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"length": {
"type": "number",
"format": "double",
"nullable": true
},
"width": {
"type": "number",
"format": "double",
"nullable": true
},
"height": {
"type": "number",
"format": "double",
"nullable": true
},
"volume": {
"type": "number",
"format": "double",
"nullable": true
},
"value": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"carriers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrier"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrier": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"markingNo": {
"type": "string",
"nullable": true
},
"carrierNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"totalWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"totalValue": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"orderDescription": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierPosition": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"nullable": true
},
"sparePartNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"transitReceivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"receivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierPositions": {
"type": "object",
"properties": {
"carrierGuid": {
"type": "string",
"nullable": true
},
"carrierNo": {
"type": "string",
"nullable": true
},
"requisitionPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierRequisitionPosition"
},
"nullable": true
},
"positionsWithoutRequisitionLink": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierPosition"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.UnitShipmentMarkingCarrierRequisitionPosition": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"nullable": true
},
"requisitionNo": {
"type": "string",
"nullable": true
},
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sparePartNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"transitReceivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"orderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"requestedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double"
},
"procurementRequisitionCurrencyNo": {
"type": "string",
"nullable": true
},
"receivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Distribution.UnitShipmentResponse": {
"type": "object",
"properties": {
"shipmentNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Document.Document": {
"type": "object",
"properties": {
"dataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"documentNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"revisionRemark": {
"type": "string",
"nullable": true
},
"documentRef": {
"type": "string",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.FileType"
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"issueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"checkOutDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"checkOutUserNo": {
"type": "string",
"nullable": true
},
"checkOutUserName": {
"type": "string",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"customProperties": {
"nullable": true
},
"fileModified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ignoreDocumentGroupMandatoryRule": {
"type": "boolean",
"nullable": true
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"documentClasses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentDocumentClass"
},
"nullable": true
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.DocumentMail.DocumentNotification"
},
"nullable": true
},
"documentWeblinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentWeblink"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Document.DocumentClass": {
"type": "object",
"properties": {
"documentClassNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Document.DocumentDocumentClass": {
"type": "object",
"properties": {
"documentNo": {
"type": "string",
"nullable": true
},
"documentClassNo": {
"type": "string",
"nullable": true
},
"documentClassName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Document.DocumentGroup": {
"type": "object",
"properties": {
"documentGroupNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"parentNo": {
"type": "string",
"nullable": true
},
"parentName": {
"type": "string",
"nullable": true
},
"allowUseOnUnit": {
"type": "boolean",
"nullable": true
},
"parentDocumentGroupUnitNo": {
"type": "string",
"nullable": true
},
"dataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Document.DocumentShare": {
"type": "object",
"properties": {
"linkType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentShareLinkType"
},
"description": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Document.DocumentShareLinkType": {
"enum": [
"Preview",
"Direct"
],
"type": "string"
},
"SerticaWebApi.Models.Document.DocumentSharePreview": {
"type": "object",
"properties": {
"filename": {
"type": "string",
"nullable": true
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"fileUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Document.DocumentTreeNode": {
"type": "object",
"properties": {
"hasChildren": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"visibleKey": {
"type": "string",
"nullable": true
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNodeType"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.DocumentTreeNode"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Document.DocumentTreeNodeType": {
"enum": [
"DocumentGroup",
"DocumentType",
"Document"
],
"type": "string"
},
"SerticaWebApi.Models.Document.DocumentType": {
"type": "object",
"properties": {
"documentTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"dataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Document.DocumentWeblink": {
"type": "object",
"properties": {
"document2Guid": {
"type": "string",
"format": "uuid"
},
"description": {
"type": "string",
"nullable": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"link": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Document.FileContentDisposition": {
"enum": [
"Inline"
],
"type": "string"
},
"SerticaWebApi.Models.Document.FileType": {
"enum": [
"None",
"File",
"Link",
"Folder"
],
"type": "string"
},
"SerticaWebApi.Models.DocumentMail.DocumentMailTemplate": {
"type": "object",
"properties": {
"documentMailTemplateNo": {
"type": "string",
"nullable": true
},
"body": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.DocumentMail.DocumentNotification": {
"type": "object",
"properties": {
"days": {
"type": "integer",
"format": "int32"
},
"daysDirection": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentNotificationDaysDirection"
},
"documentMailTemplateNo": {
"type": "string",
"nullable": true
},
"recipients": {
"type": "string",
"nullable": true
},
"dateSent": {
"type": "string",
"format": "date-time",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.BrbOperationSigner": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"roleToSignNo": {
"type": "string",
"nullable": true
},
"roleToSignName": {
"type": "string",
"nullable": true
},
"signedByUserNo": {
"type": "string",
"nullable": true
},
"signedByUserName": {
"type": "string",
"nullable": true
},
"signLevel": {
"type": "integer",
"format": "int32",
"nullable": true
},
"signed": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.DischargedProduct": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"productCategory": {
"type": "string",
"nullable": true
},
"estimatedAmountDischarged": {
"type": "number",
"format": "double",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"duration": {
"type": "integer",
"format": "int32",
"nullable": true
},
"environmentalItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationEnvironmentalItem"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Documents.GarbageReceiverDocument": {
"type": "object",
"properties": {
"garbageReceiverNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Documents.GrbOperationDocument": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbOperationDocument": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbReceiverDocument": {
"type": "object",
"properties": {
"receiverNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Documents.ReceiverDocument": {
"type": "object",
"properties": {
"receiverNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.EnvironmentalItem": {
"type": "object",
"properties": {
"environmentalItemNo": {
"type": "string",
"nullable": true
},
"environmentalItemName": {
"type": "string",
"nullable": true
},
"unitOfMeasure": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Views.EnvironmentalItemView+UnitOfMeasureEnum"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Equipment": {
"type": "object",
"properties": {
"equipmentNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"substanceNo": {
"type": "string",
"nullable": true
},
"substanceName": {
"type": "string",
"nullable": true
},
"onboardLocation": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double"
},
"capacity": {
"type": "number",
"format": "double",
"nullable": true
},
"availableCapacity": {
"type": "number",
"format": "double"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.EquipmentDetection": {
"type": "object",
"properties": {
"equipmentNo": {
"type": "string",
"nullable": true
},
"equipmentName": {
"type": "string",
"nullable": true
},
"operationNo": {
"type": "string",
"nullable": true
},
"operationStartDateUTC": {
"type": "string",
"format": "date-time"
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationStatus"
},
"quantityBefore": {
"type": "number",
"format": "double"
},
"quantity": {
"type": "number",
"format": "double"
},
"quantityAfter": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.FuelType": {
"type": "object",
"properties": {
"fuelTypeNo": {
"type": "string",
"nullable": true
},
"fuelTypeName": {
"type": "string",
"nullable": true
},
"fuelCalorificValue": {
"type": "number",
"format": "double",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver": {
"type": "object",
"properties": {
"garbageReceiverNo": {
"type": "string",
"nullable": true
},
"garbageReceiverVesselType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.GarbageRecordbook.Enums.GarbageReceiverVesselType"
},
"garbageReceiverDescription": {
"type": "string",
"nullable": true
},
"portNo": {
"type": "string",
"nullable": true
},
"portName": {
"type": "string",
"nullable": true
},
"shipName": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GarbageReceiverDocument"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.GrbOperation": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"detailsRemarks": {
"type": "string",
"nullable": true
},
"operationDetails": {
"type": "string",
"nullable": true
},
"operationEndDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"operationEndDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"operationStartDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"operationStartDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationTypeName": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationDeleted": {
"type": "boolean",
"nullable": true
},
"operationStartLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationStartLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationEndLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationEndLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationStatus"
},
"operationMarkedForDeletion": {
"type": "boolean",
"nullable": true
},
"portNo": {
"type": "string",
"nullable": true
},
"portName": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"reasonForDischarge": {
"type": "string",
"nullable": true
},
"enRoute": {
"type": "boolean",
"nullable": true
},
"specialArea": {
"type": "boolean",
"nullable": true
},
"distanceFromShore": {
"type": "number",
"format": "double",
"nullable": true
},
"waterDepth": {
"type": "number",
"format": "double",
"nullable": true
},
"methodOfDischarge": {
"type": "string",
"nullable": true
},
"nextSignerRoleNo": {
"type": "string",
"nullable": true
},
"nextSignerRoleName": {
"type": "string",
"nullable": true
},
"nextSignLevel": {
"type": "integer",
"format": "int32"
},
"isMissedOperation": {
"type": "boolean",
"nullable": true
},
"earlierMissedOperationNo": {
"type": "string",
"nullable": true
},
"latestSignerName": {
"type": "string",
"nullable": true
},
"latestSignerNo": {
"type": "string",
"nullable": true
},
"needsSigningByMyRole": {
"type": "boolean"
},
"earlierMissedOperationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GrbOperationDocument"
},
"nullable": true
},
"receiptsCertificates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.GarbageReceiverDocument"
},
"nullable": true
},
"dischargedProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.DischargedProduct"
},
"nullable": true
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationSigner"
},
"nullable": true
},
"garbageReceivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationGarbageReceiver"
},
"nullable": true
},
"receiverDetails": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
},
"missedOperation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
},
"environmentalItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationEnvironmentalItem"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.GrbOperationCreate": {
"type": "object",
"properties": {
"grbOperation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperation"
},
"missedOperation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GrbOperationCreate"
},
"garbageReceiver": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.GarbageReceiver"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.GrbOperationEnvironmentalItem": {
"type": "object",
"properties": {
"environmentalItemNo": {
"type": "string",
"nullable": true
},
"environmentalItemName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time"
},
"operationNo": {
"type": "string",
"nullable": true
},
"operationUnitNo": {
"type": "string",
"nullable": true
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationTypeName": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationStatus"
},
"unitsUsed": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"unitsLoaded": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"unitsBefore": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"unitsAfter": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.GrbOperationGarbageReceiver": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"garbageReceiverNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.GrbOperationSigner": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"roleToSignNo": {
"type": "string",
"nullable": true
},
"roleToSignName": {
"type": "string",
"nullable": true
},
"signedByUserNo": {
"type": "string",
"nullable": true
},
"signedByUserName": {
"type": "string",
"nullable": true
},
"signLevel": {
"type": "integer",
"format": "int32",
"nullable": true
},
"signed": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.LiquidType": {
"type": "object",
"properties": {
"liquidTypeNo": {
"type": "string",
"nullable": true
},
"liquid": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLiquid"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.LubeOilType": {
"type": "object",
"properties": {
"lubeOilTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"characteristics": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"detailsRemarks": {
"type": "string",
"nullable": true
},
"operationDetails": {
"type": "string",
"nullable": true
},
"detailsNotes": {
"type": "string",
"nullable": true
},
"operationEndDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"operationEndDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"operationStartDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"operationStartDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationTypeName": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationDeleted": {
"type": "boolean",
"nullable": true
},
"operationMarkedForDeletion": {
"type": "boolean",
"nullable": true
},
"operationStartLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationStartLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationEndLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationEndLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationStatus"
},
"isMissedOperation": {
"type": "boolean",
"nullable": true
},
"earlierMissedOperationNo": {
"type": "string",
"nullable": true
},
"earlierMissedOperationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"equipmentNo": {
"type": "string",
"nullable": true
},
"equipmentName": {
"type": "string",
"nullable": true
},
"equipmentQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"equipmentQuantityBefore": {
"type": "number",
"format": "double",
"nullable": true
},
"equipmentQuantityAfter": {
"type": "number",
"format": "double",
"nullable": true
},
"reason": {
"type": "string",
"nullable": true
},
"nextSignerRoleNo": {
"type": "string",
"nullable": true
},
"nextSignerRoleName": {
"type": "string",
"nullable": true
},
"nextSignLevel": {
"type": "integer",
"format": "int32"
},
"latestSignerName": {
"type": "string",
"nullable": true
},
"latestSignerNo": {
"type": "string",
"nullable": true
},
"needsSigningByMyRole": {
"type": "boolean"
},
"interventionDescriptionType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OzoneDepletingSubstancesRecordbook.Enums.InterventionDescriptionType"
},
"interventionReason": {
"type": "string",
"nullable": true
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbOperationDocument"
},
"nullable": true
},
"receiptsCertificates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbReceiverDocument"
},
"nullable": true
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationSigner"
},
"nullable": true
},
"odsrbReceivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationOdsrbReceiver"
},
"nullable": true
},
"receiverDetails": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
},
"equipment": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Equipment"
},
"missedOperation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationCreate": {
"type": "object",
"properties": {
"odsrbOperation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperation"
},
"missedOperation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationCreate"
},
"odsrbReceiver": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationOdsrbReceiver": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"receiverNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OdsrbOperationSigner": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"roleToSignNo": {
"type": "string",
"nullable": true
},
"roleToSignName": {
"type": "string",
"nullable": true
},
"signedByUserNo": {
"type": "string",
"nullable": true
},
"signedByUserName": {
"type": "string",
"nullable": true
},
"signLevel": {
"type": "integer",
"format": "int32",
"nullable": true
},
"signed": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OdsrbReceiver": {
"type": "object",
"properties": {
"receiverNo": {
"type": "string",
"nullable": true
},
"receiverVesselType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OzoneDepletingSubstancesRecordbook.Enums.OdsrbReceiverVesselType"
},
"receiverDescription": {
"type": "string",
"nullable": true
},
"portNo": {
"type": "string",
"nullable": true
},
"portName": {
"type": "string",
"nullable": true
},
"receiverTypeOtherDescription": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OdsrbReceiverDocument"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OperationSignings": {
"type": "object",
"properties": {
"operationNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"pin": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfiguration": {
"type": "object",
"properties": {
"inactive": {
"type": "boolean",
"nullable": true
},
"configured": {
"type": "boolean"
},
"inUse": {
"type": "boolean"
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationDefinition": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationDefinition"
},
"tankOperationConfigurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration"
},
"nullable": true
},
"signLevelConfigurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfigurationSignLevelConfiguration"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OperationTypeConfigurationSignLevelConfiguration": {
"type": "object",
"properties": {
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"roleNo": {
"type": "string",
"nullable": true
},
"roleName": {
"type": "string",
"nullable": true
},
"signLevel": {
"type": "integer",
"format": "int32"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OrbNoon": {
"type": "object",
"properties": {
"noonNo": {
"type": "string",
"nullable": true
},
"noonDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"noonDateOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"steamingTime": {
"type": "integer",
"format": "int32",
"nullable": true
},
"fuelConsumption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoonFuelType"
},
"nullable": true
},
"desludgings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbNoonPurifier"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OrbNoonFuelType": {
"type": "object",
"properties": {
"noonNo": {
"type": "string",
"nullable": true
},
"fuelTypeNo": {
"type": "string",
"nullable": true
},
"fuelTypeName": {
"type": "string",
"nullable": true
},
"consumed": {
"type": "number",
"format": "double",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OrbNoonPurifier": {
"type": "object",
"properties": {
"noonNo": {
"type": "string",
"nullable": true
},
"purifierNo": {
"type": "string",
"nullable": true
},
"purifierName": {
"type": "string",
"nullable": true
},
"purifierEstimatedSludgeQuantity": {
"type": "number",
"format": "double"
},
"frequency": {
"type": "number",
"format": "double",
"nullable": true
},
"duration": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OrbOperation": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"burningTimeIncinerator": {
"type": "number",
"format": "double",
"nullable": true
},
"changeOver": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Models.ChangeOver"
},
"chemicalQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"cleanedSinceLastContainedOil": {
"type": "boolean",
"nullable": true
},
"cleaningMethod": {
"type": "string",
"nullable": true
},
"detailsNotes": {
"type": "string",
"nullable": true
},
"detailsRemarks": {
"type": "string",
"nullable": true
},
"dischargedRemarks": {
"type": "string",
"nullable": true
},
"equipmentNo": {
"type": "string",
"nullable": true
},
"equipmentName": {
"type": "string",
"nullable": true
},
"equipmentQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"equipmentQuantityBefore": {
"type": "number",
"format": "double",
"nullable": true
},
"equipmentQuantityAfter": {
"type": "number",
"format": "double",
"nullable": true
},
"interventionDescriptionType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OzoneDepletingSubstancesRecordbook.Enums.InterventionDescriptionType"
},
"interventionReason": {
"type": "string",
"nullable": true
},
"failure": {
"type": "boolean",
"nullable": true
},
"failureDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"failureDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"failureReason": {
"type": "string",
"nullable": true
},
"fuelTypeNo": {
"type": "string",
"nullable": true
},
"fuelTypeName": {
"type": "string",
"nullable": true
},
"genericDestinationDescription": {
"type": "string",
"nullable": true
},
"genericDestinationName": {
"type": "string",
"nullable": true
},
"genericFuelType": {
"type": "string",
"nullable": true
},
"genericSourceDescription": {
"type": "string",
"nullable": true
},
"genericSourceName": {
"type": "string",
"nullable": true
},
"liquidAPI": {
"type": "number",
"format": "double",
"nullable": true
},
"liquidDensity": {
"type": "number",
"format": "double",
"nullable": true
},
"liquidType": {
"type": "string",
"nullable": true
},
"lubeOilTypeNo": {
"type": "string",
"nullable": true
},
"lubeOilTypeName": {
"type": "string",
"nullable": true
},
"oilResidueType": {
"type": "string",
"nullable": true
},
"operationDetails": {
"type": "string",
"nullable": true
},
"operationDescription": {
"type": "string",
"nullable": true
},
"operationEndDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"operationEndDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"operationStartDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"operationStartDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationTypeName": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationDeleted": {
"type": "boolean",
"nullable": true
},
"operationMarkedForDeletion": {
"type": "boolean",
"nullable": true
},
"bunkeringPortNo": {
"type": "string",
"nullable": true
},
"bunkeringPortName": {
"type": "string",
"nullable": true
},
"bunkeringDetails": {
"type": "string",
"nullable": true
},
"previouslyCarriedOilViscosity": {
"type": "number",
"format": "double",
"nullable": true
},
"previouslyCarriedOilDensity": {
"type": "number",
"format": "double",
"nullable": true
},
"previouslyCarriedOilType": {
"type": "string",
"nullable": true
},
"pumpStopTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"pumpStopTimeOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantityTransferred": {
"type": "number",
"format": "double",
"nullable": true
},
"destinationQuantityTransferred": {
"type": "number",
"format": "double",
"nullable": true
},
"secondDestinationQuantityTransferred": {
"type": "number",
"format": "double",
"nullable": true
},
"reasonForOilyDeviceFailure": {
"type": "string",
"nullable": true
},
"reasonForOilyDeviceFailureUnknown": {
"type": "boolean",
"nullable": true
},
"restoreForDevice": {
"type": "boolean",
"nullable": true
},
"restoreDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"restoreDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"restoreForOilyDeviceUnknown": {
"type": "boolean",
"nullable": true
},
"shipSpeedKnots": {
"type": "number",
"format": "double",
"nullable": true
},
"sulphurContent": {
"type": "number",
"format": "double",
"nullable": true
},
"sulphurPercentageExceedsOne": {
"type": "boolean",
"nullable": true
},
"combustionChamberOxygenPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"combustionChamberGasOutletTemperature": {
"type": "number",
"format": "double",
"nullable": true
},
"transferStopTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"transferStopTimeOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"typeOfChemical": {
"type": "string",
"nullable": true
},
"operationStartLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationStartLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationEndLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationEndLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationStatus"
},
"isMissedOperation": {
"type": "boolean",
"nullable": true
},
"earlierMissedOperationNo": {
"type": "string",
"nullable": true
},
"operationCausingFailureNo": {
"type": "string",
"nullable": true
},
"earlierMissedOperationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"nextSignerRoleNo": {
"type": "string",
"nullable": true
},
"nextSignerRoleName": {
"type": "string",
"nullable": true
},
"nextSignLevel": {
"type": "integer",
"format": "int32"
},
"latestSignerName": {
"type": "string",
"nullable": true
},
"latestSignerNo": {
"type": "string",
"nullable": true
},
"needsSigningByMyRole": {
"type": "boolean"
},
"isDailySounding": {
"type": "boolean",
"nullable": true
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.OrbOperationDocument"
},
"nullable": true
},
"contemporaryOperations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationContemporaryOperation"
},
"nullable": true
},
"soundings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationSounding"
},
"nullable": true
},
"receivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationReceiver"
},
"nullable": true
},
"sealSubSealPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationSealSubSealPoint"
},
"nullable": true
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationSigner"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OrbOperationContemporaryOperation": {
"type": "object",
"properties": {
"orbOperationGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"operationNo": {
"type": "string",
"nullable": true
},
"contemporaryOperationNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OrbOperationCreate": {
"type": "object",
"properties": {
"orbOperation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperation"
},
"missedOperation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.OrbOperationCreate"
},
"expectedSources": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SourceDestinationQuantity"
},
"expectedDestinations": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SourceDestinationQuantity"
},
"expectedSecondDestinations": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SourceDestinationQuantity"
},
"soundings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
},
"nullable": true
},
"receiver": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Receiver"
},
"sealSubSealPoint": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint"
},
"pin": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OrbOperationReceiver": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"receiverNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OrbOperationSealSubSealPoint": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"sealSubSealPointNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OrbOperationSigner": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"roleToSignNo": {
"type": "string",
"nullable": true
},
"roleToSignName": {
"type": "string",
"nullable": true
},
"signedByUserNo": {
"type": "string",
"nullable": true
},
"signedByUserName": {
"type": "string",
"nullable": true
},
"signLevel": {
"type": "integer",
"format": "int32",
"nullable": true
},
"signed": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.OrbOperationSounding": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"soundingNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Purifier": {
"type": "object",
"properties": {
"purifierNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"estimatedSludgeQuantity": {
"type": "number",
"format": "double"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Receiver": {
"type": "object",
"properties": {
"receiverNo": {
"type": "string",
"nullable": true
},
"receiverType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Enums.ReceiverType"
},
"receiverVesselType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Enums.ReceiverVesselType"
},
"receiverDescription": {
"type": "string",
"nullable": true
},
"portNo": {
"type": "string",
"nullable": true
},
"portName": {
"type": "string",
"nullable": true
},
"receiverPortDetails": {
"type": "string",
"nullable": true
},
"receiverTypeOtherDescription": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Documents.ReceiverDocument"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Seal": {
"type": "object",
"properties": {
"sealNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"sealDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"sealDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sealTypeNo": {
"type": "string",
"nullable": true
},
"sealTypeName": {
"type": "string",
"nullable": true
},
"currentSubSealPointNo": {
"type": "string",
"nullable": true
},
"currentSubSealPointName": {
"type": "string",
"nullable": true
},
"sealStorageLocationNo": {
"type": "string",
"nullable": true
},
"sealStorageLocationName": {
"type": "string",
"nullable": true
},
"sealStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SealStatus"
},
"remark": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.SealSubSealPoint": {
"type": "object",
"properties": {
"sealSubSealPointNo": {
"type": "string",
"nullable": true
},
"sealNo": {
"type": "string",
"nullable": true
},
"sealDescription": {
"type": "string",
"nullable": true
},
"subSealPointNo": {
"type": "string",
"nullable": true
},
"subSealPointName": {
"type": "string",
"nullable": true
},
"responsibleUserNo": {
"type": "string",
"nullable": true
},
"responsibleUserName": {
"type": "string",
"nullable": true
},
"sealSubSealPointDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"sealSubSealPointDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sealSubSealPointType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SealSubSealPointType"
},
"sealAffixReason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SealAffixReason"
},
"sealBreakReason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SealBreakReason"
},
"remark": {
"type": "string",
"nullable": true
},
"pin": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.SealType": {
"type": "object",
"properties": {
"sealTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Sounding": {
"type": "object",
"properties": {
"soundingNo": {
"type": "string",
"nullable": true
},
"tankNo": {
"type": "string",
"nullable": true
},
"tankName": {
"type": "string",
"nullable": true
},
"sourceBilgeTankName": {
"type": "string",
"nullable": true
},
"tankTransversalPosition": {
"type": "string",
"nullable": true
},
"tankPositionFromFrame": {
"type": "number",
"format": "double",
"nullable": true
},
"tankPositionToFrame": {
"type": "number",
"format": "double",
"nullable": true
},
"tankCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"tankIOPPType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookIOPPType"
},
"soundingType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Views.SoundingView+SoundingTypeEnum"
},
"isSourceSounding": {
"type": "boolean",
"nullable": true
},
"isDestinationSounding": {
"type": "boolean",
"nullable": true
},
"isSecondDestinationSounding": {
"type": "boolean",
"nullable": true
},
"beforeSoundingStatusNo": {
"type": "string",
"nullable": true
},
"beforeSoundingStatusSound": {
"type": "number",
"format": "double",
"nullable": true
},
"beforeSoundingStatusTrim": {
"type": "number",
"format": "double",
"nullable": true
},
"beforeSoundingStatusVolume": {
"type": "number",
"format": "double",
"nullable": true
},
"afterSoundingStatusNo": {
"type": "string",
"nullable": true
},
"afterSoundingStatusSound": {
"type": "number",
"format": "double",
"nullable": true
},
"afterSoundingStatusTrim": {
"type": "number",
"format": "double",
"nullable": true
},
"afterSoundingStatusVolume": {
"type": "number",
"format": "double",
"nullable": true
},
"liquidTypeNo": {
"type": "string",
"nullable": true
},
"isCustomTankSounding": {
"type": "boolean",
"nullable": true
},
"customTankName": {
"type": "string",
"nullable": true
},
"customTankDescription": {
"type": "string",
"nullable": true
},
"liquid": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLiquid"
},
"productClass": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookProductClass"
},
"tankType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationSourceDestination"
},
"orbOperationStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationStatus"
},
"orbOperationNo": {
"type": "string",
"nullable": true
},
"beforeSoundingStatus": {
"nullable": true
},
"afterSoundingStatus": {
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.SoundingStatus": {
"type": "object",
"properties": {
"soundingStatusNo": {
"type": "string",
"nullable": true
},
"sound": {
"type": "number",
"format": "double",
"nullable": true
},
"trimLevel": {
"type": "number",
"format": "double",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"volume": {
"type": "number",
"format": "double",
"nullable": true
},
"density": {
"type": "number",
"format": "double",
"nullable": true
},
"ullage": {
"type": "boolean",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.SoundingTable": {
"type": "object",
"properties": {
"soundingTableNo": {
"type": "string",
"nullable": true
},
"sheetNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"soundingTableData": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.OilRecordbook.Models.SoundingTableData"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.SourceDestinationQuantity": {
"enum": [
"None",
"Single",
"Multiple"
],
"type": "string"
},
"SerticaWebApi.Models.ElectronicLogBook.Substance": {
"type": "object",
"properties": {
"substanceNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.Tank": {
"type": "object",
"properties": {
"tankNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"calculateGenerated": {
"type": "boolean"
},
"capacity": {
"type": "number",
"format": "double"
},
"fuelTypeNo": {
"type": "string",
"nullable": true
},
"fuelTypeName": {
"type": "string",
"nullable": true
},
"highLevelAlarmThreshold": {
"type": "number",
"format": "double"
},
"lowLevelAlarmThreshold": {
"type": "number",
"format": "double"
},
"levelTolerance": {
"type": "number",
"format": "double",
"nullable": true
},
"iopp": {
"type": "boolean"
},
"ioppName": {
"type": "string",
"nullable": true
},
"transversalPosition": {
"type": "string",
"nullable": true
},
"ioppType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookIOPPType"
},
"lubeOilTypeNo": {
"type": "string",
"nullable": true
},
"lubeOilTypeName": {
"type": "string",
"nullable": true
},
"negativeVarianceMaxValue": {
"type": "number",
"format": "double",
"nullable": true
},
"negativeVarianceMessage": {
"type": "string",
"nullable": true
},
"negativeVarianceMessageType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TankVarianceType"
},
"positionFromFrame": {
"type": "number",
"format": "double",
"nullable": true
},
"positionFromLevel": {
"type": "integer",
"format": "int32",
"nullable": true
},
"positionToFrame": {
"type": "number",
"format": "double",
"nullable": true
},
"positionToLevel": {
"type": "integer",
"format": "int32",
"nullable": true
},
"positiveVarianceMaxValue": {
"type": "number",
"format": "double",
"nullable": true
},
"positiveVarianceMessage": {
"type": "string",
"nullable": true
},
"positiveVarianceMessageType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TankVarianceType"
},
"productClass": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookProductClass"
},
"trimCorrection": {
"type": "boolean"
},
"tanksOverview": {
"type": "boolean"
},
"dailySounding": {
"type": "boolean"
},
"dailySoundingPosition": {
"type": "integer",
"format": "int32",
"nullable": true
},
"trimTolerance": {
"type": "number",
"format": "double",
"nullable": true
},
"ullage": {
"type": "boolean"
},
"isGenericSource": {
"type": "boolean"
},
"logbooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankLogbook"
},
"nullable": true
},
"logbooksAsString": {
"type": "string",
"nullable": true
},
"compartments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankCompartment"
},
"nullable": true
},
"soundingTableEnabled": {
"type": "boolean"
},
"soundingTableNo": {
"type": "string",
"nullable": true
},
"soundingTableData": {
"nullable": true
},
"isInitialized": {
"type": "boolean",
"nullable": true
},
"withCompartments": {
"type": "boolean"
},
"tankType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationSourceDestination"
},
"lastRecordedVolume": {
"type": "number",
"format": "double",
"nullable": true
},
"lastRecordedLiquid": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLiquid"
},
"lastRecordedLiquidTypeNo": {
"type": "string",
"nullable": true
},
"lastRecordedDensity": {
"type": "number",
"format": "double",
"nullable": true
},
"lastRecordedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.TankCompartment": {
"type": "object",
"properties": {
"tankGuid": {
"type": "string",
"format": "uuid"
},
"tankNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.TankLogbook": {
"type": "object",
"properties": {
"tankNo": {
"type": "string",
"nullable": true
},
"logbook": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
},
"tankGuid": {
"type": "string",
"format": "uuid"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.TankOperationConfiguration": {
"type": "object",
"properties": {
"tankOperationConfigurationNo": {
"type": "string",
"nullable": true
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationTypeConfigurationGuid": {
"type": "string",
"format": "uuid"
},
"configurationGroup": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"sourceTankNamesAsString": {
"type": "string",
"nullable": true
},
"destinationTankNamesAsString": {
"type": "string",
"nullable": true
},
"secondDestinationTankNamesAsString": {
"type": "string",
"nullable": true
},
"sourceTanks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
},
"nullable": true
},
"destinationTanks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
},
"nullable": true
},
"secondDestinationTanks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogBook.TankOperationConfigurationTank": {
"type": "object",
"properties": {
"tankOperationConfigurationNo": {
"type": "string",
"nullable": true
},
"tankType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationSourceDestination"
},
"tankNo": {
"type": "string",
"nullable": true
},
"tankName": {
"type": "string",
"nullable": true
},
"isSourceTank": {
"type": "boolean"
},
"isDestinationTank": {
"type": "boolean"
},
"isSecondDestinationTank": {
"type": "boolean"
},
"isGenericTank": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.BrbOperation": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"detailsRemarks": {
"type": "string",
"nullable": true
},
"operationDetails": {
"type": "string",
"nullable": true
},
"operationEndDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"operationEndDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"operationStartDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"operationStartDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"needsSigningByMyRole": {
"type": "boolean"
},
"nextSignerRoleNo": {
"type": "string",
"nullable": true
},
"nextSignerRoleName": {
"type": "string",
"nullable": true
},
"nextSignLevel": {
"type": "integer",
"format": "int32"
},
"latestSignerName": {
"type": "string",
"nullable": true
},
"latestSignerNo": {
"type": "string",
"nullable": true
},
"operationDeleted": {
"type": "boolean",
"nullable": true
},
"operationMarkedForDeletion": {
"type": "boolean",
"nullable": true
},
"operationStartLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationStartLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationEndLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"operationEndLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"isMissedOperation": {
"type": "boolean",
"nullable": true
},
"earlierMissedOperationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"earlierMissedOperationNo": {
"type": "string",
"nullable": true
},
"operationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationTypeName": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.Shared.Models.Operations.OperationType"
},
"operationStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationStatus"
},
"operationDescription": {
"type": "string",
"nullable": true
},
"quantityTransferred": {
"type": "number",
"format": "double",
"nullable": true
},
"quantityCirculatedTreated": {
"type": "number",
"format": "double",
"nullable": true
},
"minimumWaterDepthDuringUptake": {
"type": "number",
"format": "double",
"nullable": true
},
"waterDepth": {
"type": "number",
"format": "double",
"nullable": true
},
"distanceFromShore": {
"type": "number",
"format": "double",
"nullable": true
},
"liquidDensity": {
"type": "number",
"format": "double",
"nullable": true
},
"salinityPSU": {
"type": "number",
"format": "double",
"nullable": true
},
"managementPlanAccordance": {
"type": "boolean",
"nullable": true
},
"ballastWaterProcessingMethod": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"portNo": {
"type": "string",
"nullable": true
},
"portName": {
"type": "string",
"nullable": true
},
"bwmsFixDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"bwmsFixDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"bwmsFailureFixed": {
"type": "boolean",
"nullable": true
},
"bwmsFailureFixedAtSameLocation": {
"type": "boolean",
"nullable": true
},
"bwmsFailurePortNo": {
"type": "string",
"nullable": true
},
"bwmsFailurePortName": {
"type": "string",
"nullable": true
},
"bwmsFailureLocation": {
"type": "string",
"nullable": true
},
"bwmsFixPortNo": {
"type": "string",
"nullable": true
},
"bwmsFixPortName": {
"type": "string",
"nullable": true
},
"bwmsFixLocation": {
"type": "string",
"nullable": true
},
"facilityNameAndLocation": {
"type": "string",
"nullable": true
},
"portStateDesignatedArea": {
"type": "boolean",
"nullable": true
},
"designatedAreaDetails": {
"type": "string",
"nullable": true
},
"circumstancesDetails": {
"type": "string",
"nullable": true
},
"exchangeMethod": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ExchangeMethod"
},
"operationCarriedOutType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OperationCarriedOutType"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument"
},
"nullable": true
},
"receiptsCertificates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbReceiverDocument"
},
"nullable": true
},
"brbReceivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperationBrbReceiver"
},
"nullable": true
},
"receiverDetails": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
},
"soundings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperationSounding"
},
"nullable": true
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.BrbOperationSigner"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.BrbOperationBrbReceiver": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"brbReceiverNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.BrbOperationCreate": {
"type": "object",
"properties": {
"brbOperation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperation"
},
"missedOperation": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbOperationCreate"
},
"expectedSources": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SourceDestinationQuantity"
},
"expectedDestinations": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.SourceDestinationQuantity"
},
"soundings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogBook.Sounding"
},
"nullable": true
},
"receiver": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.BrbReceiver"
},
"pin": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.BrbOperationSounding": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"soundingNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.BrbReceiver": {
"type": "object",
"properties": {
"brbReceiverNo": {
"type": "string",
"nullable": true
},
"brbReceiverVesselType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ElectronicLogbook.BallastRecordbook.Enums.BrbReceiverVesselType"
},
"brbReceiverDescription": {
"type": "string",
"nullable": true
},
"portNo": {
"type": "string",
"nullable": true
},
"portName": {
"type": "string",
"nullable": true
},
"otherReceptionFacilityName": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ElectronicLogbook.Documents.BrbReceiverDocument"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.DeletionPINVerification": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.Documents.BrbOperationDocument": {
"type": "object",
"properties": {
"operationNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.Documents.BrbReceiverDocument": {
"type": "object",
"properties": {
"brbReceiverNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.PrintoutOptions": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"includeDraft": {
"type": "boolean"
},
"part": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.SealStatusUpdate": {
"type": "object",
"properties": {
"sealNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"sealStatus": {
"type": "string",
"nullable": true
},
"sealStorageLocationNo": {
"type": "string",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"sealDateUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"sealDateUTCOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"pin": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.SealStorageLocation": {
"type": "object",
"properties": {
"sealStorageLocationNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.SubSealPoint": {
"type": "object",
"properties": {
"subSealPointNo": {
"type": "string",
"nullable": true
},
"systemEquipment": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"model": {
"type": "string",
"nullable": true
},
"makerName": {
"type": "string",
"nullable": true
},
"makerReference": {
"type": "string",
"nullable": true
},
"technicalSpecification": {
"type": "string",
"nullable": true
},
"subSealPointComponentTypeNo": {
"type": "string",
"nullable": true
},
"subSealPointComponentTypeName": {
"type": "string",
"nullable": true
},
"subSealPointStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SubSealPointStatus"
},
"sealNo": {
"type": "string",
"nullable": true
},
"sealDescription": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.SubSealPointComponentType": {
"type": "object",
"properties": {
"subSealPointComponentTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ElectronicLogbook.UserUnitMovementUpdate": {
"type": "object",
"properties": {
"userNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"portCodeNo": {
"type": "string",
"nullable": true
},
"userUnitMovementDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"userUnitMovementDateOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"disembarkReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ErrorReason": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"fieldName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.EventReport.EventReport": {
"type": "object",
"properties": {
"eventReportNo": {
"type": "string",
"nullable": true
},
"eventTypeNo": {
"type": "string",
"nullable": true
},
"eventTypeName": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"eventDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expectedCompletedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"groundsReasonName": {
"type": "string",
"nullable": true
},
"groundsReasonText": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+EventStatus"
},
"postponementStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+EventPostponementStatus"
},
"canApprove": {
"type": "boolean"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.EventReport.EventReportApprovalInfo": {
"type": "object",
"properties": {
"remarks": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ExpectedFault.ExpectedFault": {
"type": "object",
"properties": {
"expectedFaultNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ExternalItem.ExternalItem": {
"type": "object",
"properties": {
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"externalItemNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"manufacturerItemNo": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.FinancialFollowup.FinancialFollowupNodeResponse": {
"type": "object",
"properties": {
"budgetPeriodName": {
"type": "string",
"nullable": true
},
"budgetPeriodNo": {
"type": "string",
"nullable": true
},
"month": {
"type": "string",
"format": "date-time",
"nullable": true
},
"mode": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.BudgetModule.FinancialFollowupSummary+Mode"
},
"text": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"technicalAccountName": {
"type": "string",
"nullable": true
},
"technicalAccountNo": {
"type": "string",
"nullable": true
},
"purchaseTypeName": {
"type": "string",
"nullable": true
},
"purchaseTypeNo": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"divisionName": {
"type": "string",
"nullable": true
},
"divisionNo": {
"type": "string",
"nullable": true
},
"icName": {
"type": "string",
"nullable": true
},
"icNo": {
"type": "string",
"nullable": true
},
"incidentDescription": {
"type": "string",
"nullable": true
},
"incidentNo": {
"type": "string",
"nullable": true
},
"marketProductName": {
"type": "string",
"nullable": true
},
"marketProductNo": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"projectNo": {
"type": "string",
"nullable": true
},
"projectCodeName": {
"type": "string",
"nullable": true
},
"projectCodeNo": {
"type": "string",
"nullable": true
},
"routeName": {
"type": "string",
"nullable": true
},
"routeNo": {
"type": "string",
"nullable": true
},
"sundryName": {
"type": "string",
"nullable": true
},
"sundryNo": {
"type": "string",
"nullable": true
},
"agentName": {
"type": "string",
"nullable": true
},
"agentNo": {
"type": "string",
"nullable": true
},
"accountSubTypeName": {
"type": "string",
"nullable": true
},
"accountSubTypeNo": {
"type": "string",
"nullable": true
},
"freeDimensionName": {
"type": "string",
"nullable": true
},
"freeDimensionNo": {
"type": "string",
"nullable": true
},
"displayStructureNodeName": {
"type": "string",
"nullable": true
},
"displayStructureNodeNo": {
"type": "string",
"nullable": true
},
"displayStructureNodeGuid": {
"type": "string",
"nullable": true
},
"displayStructureNo": {
"type": "string",
"nullable": true
},
"displayStructureName": {
"type": "string",
"nullable": true
},
"recipientNo": {
"type": "string",
"nullable": true
},
"recipientName": {
"type": "string",
"nullable": true
},
"baseUnitNo": {
"type": "string",
"nullable": true
},
"baseUnitName": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.ActivityGroup": {
"type": "object",
"properties": {
"activityGroupNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"helpDescription": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.Form": {
"type": "object",
"properties": {
"formNo": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormStatus"
},
"reportDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"reportedByNo": {
"type": "string",
"nullable": true
},
"reportedByName": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"companyLeadNo": {
"type": "string",
"nullable": true
},
"companyLeadName": {
"type": "string",
"nullable": true
},
"companyLeadUserRoleType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"unitLeadNo": {
"type": "string",
"nullable": true
},
"unitLeadName": {
"type": "string",
"nullable": true
},
"unitLeadUserRoleType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"enforceConfidentiality": {
"type": "boolean",
"nullable": true
},
"fixedApprovalFlow": {
"type": "boolean",
"nullable": true
},
"confidentialityLockedByTemplate": {
"type": "boolean",
"nullable": true
},
"formObject": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.SerticaFormObject"
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponse"
},
"nullable": true
},
"confidentialityUserRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormConfidentialityUserRole"
},
"nullable": true
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormApprover"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormDocument"
},
"nullable": true
},
"formValues": {
"nullable": true
},
"canApprove": {
"type": "boolean"
},
"formTemplateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormTemplateFormEditor"
},
"activityGroupNo": {
"type": "string",
"nullable": true
},
"allowAdditionalApprovers": {
"type": "boolean",
"nullable": true
},
"formDocumentNo": {
"type": "string",
"nullable": true
},
"formDocumentName": {
"type": "string",
"nullable": true
},
"formDocumentFileName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormActions": {
"type": "object",
"properties": {
"allowApproveForm": {
"type": "boolean"
},
"allowRejectForm": {
"type": "boolean"
},
"allowFillOutForm": {
"type": "boolean"
},
"allowReopenForm": {
"type": "boolean"
},
"allowShowForm": {
"type": "boolean"
},
"allowRequestApproval": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormAppObject": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormStatus"
},
"formJSONbase64String": {
"type": "string",
"nullable": true
},
"formTemplateGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"baseUnitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"createUserGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"reportDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"serticaFormNo": {
"type": "string",
"nullable": true
},
"hashCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"deviceFormTemplateGuid": {
"type": "string",
"nullable": true
},
"forceSubmitted": {
"type": "boolean"
},
"deletedInApp": {
"type": "boolean"
},
"reopenInApp": {
"type": "boolean"
},
"serticaFormResponseList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormResponseAppObject"
},
"nullable": true
},
"hasBeenRejected": {
"type": "boolean",
"nullable": true
},
"jobFormTemplateGuid": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormAppRequest": {
"type": "object",
"properties": {
"unitGuidList": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"deviceFormList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormAppObject"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormApprover": {
"type": "object",
"properties": {
"formNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"approvalOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"updatedByUserNo": {
"type": "string",
"nullable": true
},
"updatedByUserName": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormApproverStatus"
},
"addedBy": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormApproverAddedBy"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormBrowserNode": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"keys": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeKeys"
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeType"
},
"unitNo": {
"type": "string",
"nullable": true
},
"hasParent": {
"type": "boolean",
"readOnly": true
},
"parentVisibleKey": {
"type": "string",
"nullable": true
},
"hasChildren": {
"type": "boolean"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNode"
},
"nullable": true
},
"childNodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormBrowserNodeType"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormBrowserNodeKeys": {
"type": "object",
"properties": {
"activityGroupKey": {
"type": "string",
"nullable": true
},
"formTemplateKey": {
"type": "string",
"nullable": true
},
"yearKey": {
"type": "string",
"nullable": true
},
"monthKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormBrowserNodeType": {
"enum": [
"Root",
"ActivityGroup",
"FormTemplate",
"Year",
"Month",
"None"
],
"type": "string"
},
"SerticaWebApi.Models.Form.FormConfidentialityUserRole": {
"type": "object",
"properties": {
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"formNo": {
"type": "string",
"nullable": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole+CombinedType"
},
"addedFromFormTemplate": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormDocument": {
"type": "object",
"properties": {
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"formNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormRejectReason": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"recipient": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormResponse": {
"type": "object",
"properties": {
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"formNo": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormResponseAppObject": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"baseUnitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"isRejectResponseLog": {
"type": "boolean",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"serticaFormGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormTemplate": {
"type": "object",
"properties": {
"formTemplateNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"helpDescription": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"activityGroupNo": {
"type": "string",
"nullable": true
},
"activityGroupName": {
"type": "string",
"nullable": true
},
"companyLeadNo": {
"type": "string",
"nullable": true
},
"companyLeadName": {
"type": "string",
"nullable": true
},
"companyLeadUserRoleType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"unitLeadNo": {
"type": "string",
"nullable": true
},
"unitLeadName": {
"type": "string",
"nullable": true
},
"unitLeadUserRoleType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"enforceConfidentiality": {
"type": "boolean"
},
"inactive": {
"type": "boolean"
},
"fixedApprovalFlow": {
"type": "boolean"
},
"allowAdditionalApprovers": {
"type": "boolean"
},
"formTemplateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormTemplateFormEditor"
},
"jobFormTemplateDefaultAction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobFormTemplateDefaultAction"
},
"hashCode": {
"type": "integer",
"format": "int32"
},
"formObject": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SerticaForms.SerticaFormObject"
},
"confidentialityUserRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateConfidentialityUserRole"
},
"nullable": true
},
"functionAreas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateFunctionArea"
},
"nullable": true
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateApprover"
},
"nullable": true
},
"automaticDeletions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAutomaticDeletion"
},
"nullable": true
},
"templateCustomProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateCustomProperty"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormTemplateAppObject": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid"
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"formTemplateGuid": {
"type": "string",
"format": "uuid"
},
"formLayoutJSON": {
"type": "string",
"nullable": true
},
"hashCode": {
"type": "integer",
"format": "int32"
},
"activityGroupGuid": {
"type": "string",
"nullable": true
},
"helpDescription": {
"type": "string",
"nullable": true
},
"doNotShowInApp": {
"type": "boolean"
},
"formTemplateAvailable": {
"type": "boolean"
},
"formTemplateConfidentialityList": {
"type": "string",
"nullable": true
},
"requiresApproval": {
"type": "boolean"
},
"formTemplateType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormTemplateFormEditor"
},
"onlyCreateFormsFromJobs": {
"type": "boolean",
"nullable": true
},
"enforceConfidentiality": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormTemplateAppRequest": {
"type": "object",
"properties": {
"unitGuidList": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"deviceFormTemplateList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.FormTemplateAppObject"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormTemplateApprover": {
"type": "object",
"properties": {
"formTemplateNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"approvalOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormTemplateAutomaticDeletion": {
"type": "object",
"properties": {
"formTemplateNo": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"monthsBeforeDeletion": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormTemplateConfidentialityUserRole": {
"type": "object",
"properties": {
"formTemplateGuid": {
"type": "string",
"format": "uuid"
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"defaultExpiryDays": {
"type": "integer",
"format": "int32"
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole+CombinedType"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormTemplateCustomProperty": {
"type": "object",
"properties": {
"formTemplateNo": {
"type": "string",
"nullable": true
},
"tag": {
"type": "string",
"nullable": true
},
"displayName": {
"type": "string",
"nullable": true
},
"dataType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormTemplateCustomPropertyDataType"
},
"systemTag": {
"type": "boolean"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormTemplateFunctionArea": {
"type": "object",
"properties": {
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"functionAreaNo": {
"type": "string",
"nullable": true
},
"functionAreaName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormTemplateTable": {
"type": "object",
"properties": {
"formTemplateTableNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"allowDeleteRows": {
"type": "boolean"
},
"allowNewRows": {
"type": "boolean"
},
"allowRowFilteringAndSorting": {
"type": "boolean"
},
"tableRows": {
"type": "integer",
"format": "int32"
},
"tableObject": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.FormTemplateTableJSON"
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.FormTemplateTableFieldNameDto": {
"type": "object",
"properties": {
"formTemplateTableFieldName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.ListOfValueTemplate": {
"type": "object",
"properties": {
"listOfValuesTemplateNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Form.ListOfValueTemplateValue"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Form.ListOfValueTemplateValue": {
"type": "object",
"properties": {
"valueText": {
"type": "string",
"nullable": true
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"listOfValuesTemplateNo": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Framework.Amount": {
"type": "object",
"properties": {
"value": {
"type": "number",
"format": "double"
},
"currencyNo": {
"type": "string",
"nullable": true
},
"decimalPlaces": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Framework.IosDataSyncResetObject": {
"type": "object",
"properties": {
"deviceGuid": {
"type": "string",
"nullable": true
},
"objectGuids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Framework.LocalizationText": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"text": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Framework.LoggedInUser": {
"type": "object",
"properties": {
"login": {
"type": "string",
"nullable": true
},
"languageNo": {
"type": "string",
"nullable": true
},
"userNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"userUnitNo": {
"type": "string",
"nullable": true
},
"userGuid": {
"type": "string",
"nullable": true
},
"roleNo": {
"type": "string",
"nullable": true
},
"roleName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"locale": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"totpEnabled": {
"type": "boolean",
"nullable": true
},
"showProcurementTaskListAtLogin": {
"type": "boolean",
"nullable": true
},
"forcePasswordChange": {
"type": "boolean",
"nullable": true
},
"roleList": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"canAcknowledgeUnitList": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"canMarkAsReadUnitList": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Framework.LoginRole": {
"type": "object",
"properties": {
"roleNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"default": {
"type": "boolean"
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.FunctionArea.FunctionArea": {
"type": "object",
"properties": {
"functionAreaNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionAreaUnit"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.FunctionArea.FunctionAreaUnit": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"functionAreaNo": {
"type": "string",
"nullable": true
},
"functionAreaName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.GridColumnLayout": {
"type": "object",
"properties": {
"gridKey": {
"type": "string",
"nullable": true
},
"dynamicGridSetup": {
"nullable": true
},
"overwritePersonalLayouts": {
"type": "boolean"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ExecuteApproveRequest": {
"type": "object",
"properties": {
"invoiceNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"context": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ApproveArguments"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ExecuteForwardForApprovalRequest": {
"type": "object",
"properties": {
"invoiceNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"context": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.ForwardForApprovalArguments"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ExecutePreApproveRequest": {
"type": "object",
"properties": {
"invoiceNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"context": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.InvoiceManagement.PreApproveArguments"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoice": {
"type": "object",
"properties": {
"invoiceNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"isOverdue": {
"type": "boolean"
},
"overdueDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderDescription": {
"type": "string",
"nullable": true
},
"purchaseOrderStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderStatus"
},
"purchaseOrderWorkflow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderWorkflow"
},
"purchaseOrderSetPOStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceSetPOStatus"
},
"multiplePurchaseOrders": {
"type": "boolean",
"nullable": true
},
"documentWebLinkNo": {
"type": "string",
"nullable": true
},
"totalOutstandingForInvoicingForAllPurchaseOrders": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyCode": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"canApprove": {
"type": "boolean",
"nullable": true
},
"standardCurrencyCode": {
"type": "string",
"nullable": true
},
"supplierInvoiceNo": {
"type": "string",
"nullable": true
},
"supplierVATNo": {
"type": "string",
"nullable": true
},
"documentType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceDocumentType"
},
"vatCodeNo": {
"type": "string",
"nullable": true
},
"vatCodeName": {
"type": "string",
"nullable": true
},
"vatRate": {
"type": "number",
"format": "double",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceStatus"
},
"referenceImInvoiceNo": {
"type": "string",
"nullable": true
},
"referenceImInvoiceDescription": {
"type": "string",
"nullable": true
},
"automatched": {
"type": "boolean",
"nullable": true
},
"approvedOnHold": {
"type": "boolean",
"nullable": true
},
"preApproved": {
"type": "boolean",
"nullable": true
},
"reversal": {
"type": "boolean",
"nullable": true
},
"importedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"supplierDueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"registeredDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"postingDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"responsibleUserNo": {
"type": "string",
"nullable": true
},
"responsibleUserName": {
"type": "string",
"nullable": true
},
"nextApproverNo": {
"type": "string",
"nullable": true
},
"nextApproverName": {
"type": "string",
"nullable": true
},
"nextApproverType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"forwardForApprovalResponsibleNo": {
"type": "string",
"nullable": true
},
"forwardForApprovalResponsibleName": {
"type": "string",
"nullable": true
},
"prepaidStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"prepaidEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"firstForwardedForApprovalDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalReference1": {
"type": "string",
"nullable": true
},
"externalReference2": {
"type": "string",
"nullable": true
},
"externalReference3": {
"type": "string",
"nullable": true
},
"externalReference4": {
"type": "string",
"nullable": true
},
"externalSystem": {
"type": "string",
"nullable": true
},
"externalDocumentNo": {
"type": "string",
"nullable": true
},
"paymentStatus": {
"type": "string",
"nullable": true
},
"paymentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"clearingDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externalCreateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"alternatePayerNo": {
"type": "string",
"nullable": true
},
"alternatePayerName": {
"type": "string",
"nullable": true
},
"interfaceDocumentType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceInterfaceDocumentType"
},
"invoiceNetAmount": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"invoiceNetAmountMatched": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"invoiceNetAmountDifference": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"additionalCostAmount": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"additionalCostMatched": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"additionalCostDifference": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"vatAmount": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"vatMatched": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"vatDifference": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"invoiceTotalAmount": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"invoiceTotalMatched": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"invoiceTotalDifference": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"invoiceTotalAmountInStandardCurrency": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"tryMatching": {
"type": "boolean"
},
"accountingDimensions": {
"nullable": true
},
"usedDimensions": {
"nullable": true
},
"invoiceSubTotal": {
"type": "number",
"format": "double"
},
"approvalSetupNo": {
"type": "string",
"nullable": true
},
"approvalSetupName": {
"type": "string",
"nullable": true
},
"purchaseOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePurchaseOrder"
},
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceResponse"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceDocument2Link"
},
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoicePosition"
},
"nullable": true
},
"additionalCosts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceAdditionalCost"
},
"nullable": true
},
"evaluations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink"
},
"nullable": true
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoiceApprover"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceAdditionalCost": {
"type": "object",
"properties": {
"invoiceNo": {
"type": "string",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"deliveryCostNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"vatNo": {
"type": "string",
"nullable": true
},
"vatName": {
"type": "string",
"nullable": true
},
"vatRate": {
"type": "number",
"format": "double",
"nullable": true
},
"vatAmount": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"postingDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"additionalCostUnitNo": {
"type": "string",
"nullable": true
},
"additionalCostUnitName": {
"type": "string",
"nullable": true
},
"accountSFINo": {
"type": "string",
"nullable": true
},
"accountSFIName": {
"type": "string",
"nullable": true
},
"projectNo": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"incidentNo": {
"type": "string",
"nullable": true
},
"incidentDescription": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"invoiceCurrencyNo": {
"type": "string",
"nullable": true
},
"classNo": {
"type": "string",
"nullable": true
},
"className": {
"type": "string",
"nullable": true
},
"handled": {
"type": "boolean",
"nullable": true
},
"accountingDimensions": {
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceApprovalInfo": {
"type": "object",
"properties": {
"remarks": {
"type": "string",
"nullable": true
},
"rejectReasonNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceApprover": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"reasonNo": {
"type": "string",
"nullable": true
},
"reasonName": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"current": {
"type": "boolean"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceCreateSelection": {
"type": "object",
"properties": {
"selectedPurchaseOrderNo": {
"type": "string",
"nullable": true
},
"selectedUnitNo": {
"type": "string",
"nullable": true
},
"selectedCompanyNo": {
"type": "string",
"nullable": true
},
"selectedSupplierNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceDocument2Link": {
"type": "object",
"properties": {
"invoiceNo": {
"type": "string",
"nullable": true
},
"isInvoice": {
"type": "boolean",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceExternalPaymentInfo": {
"type": "object",
"properties": {
"externalDocumentNo": {
"type": "string",
"nullable": true
},
"externalCreateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"paymentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"clearingDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"paymentStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceMoveToUnitResult": {
"type": "object",
"properties": {
"imInvoice": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.MoveToUnitIssue"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoicePosition": {
"type": "object",
"properties": {
"invoiceNo": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"measuringUnitNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"discountPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"vatCode": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"departmentUnitExternalReference1": {
"type": "string",
"nullable": true
},
"departmentUnitExternalReference2": {
"type": "string",
"nullable": true
},
"departmentUnitExternalReference3": {
"type": "string",
"nullable": true
},
"projectNo": {
"type": "string",
"nullable": true
},
"projectUnitExternalReference1": {
"type": "string",
"nullable": true
},
"projectUnitExternalReference2": {
"type": "string",
"nullable": true
},
"projectUnitExternalReference3": {
"type": "string",
"nullable": true
},
"incidentNo": {
"type": "string",
"nullable": true
},
"classNo": {
"type": "string",
"nullable": true
},
"sfiNo": {
"type": "string",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"userNo": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"customReference1": {
"type": "string",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sapInternalOrderNo": {
"type": "string",
"nullable": true
},
"lineAmount": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"vatAmount": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"lineTotal": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"unitExternalReference1": {
"type": "string",
"nullable": true
},
"unitExternalReference2": {
"type": "string",
"nullable": true
},
"unitExternalReference3": {
"type": "string",
"nullable": true
},
"materialNo": {
"type": "string",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderPositionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseOrderPositionUnitNo": {
"type": "string",
"nullable": true
},
"purchaseOrderPositionReceivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseOrderPositionOrderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseOrderPositionOutstandingQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseOrderPositionRejectedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"supplierItemNo": {
"type": "string",
"nullable": true
},
"purchaseOrderPositionPrice": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"purchaseOrderCurrencyNo": {
"type": "string",
"nullable": true
},
"approvedInvoicedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"outstandingQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"vatName": {
"type": "string",
"nullable": true
},
"vatRate": {
"type": "number",
"format": "double",
"nullable": true
},
"positionUnitNo": {
"type": "string",
"nullable": true
},
"positionUnitName": {
"type": "string",
"nullable": true
},
"sfiName": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"purchaseOrderPositionReferenceValue": {
"type": "string",
"nullable": true
},
"className": {
"type": "string",
"nullable": true
},
"incidentDescription": {
"type": "string",
"nullable": true
},
"incidentCategory": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"invoiceCurrencyNo": {
"type": "string",
"nullable": true
},
"itemUnitNo": {
"type": "string",
"nullable": true
},
"handled": {
"type": "boolean",
"nullable": true
},
"accountingDimensions": {
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoicePurchaseOrder": {
"type": "object",
"properties": {
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderDescription": {
"type": "string",
"nullable": true
},
"invoiceNo": {
"type": "string",
"nullable": true
},
"invoiceDescription": {
"type": "string",
"nullable": true
},
"showInHeader": {
"type": "boolean",
"nullable": true
},
"setPoStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImInvoiceSetPOStatus"
},
"invoiceStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+InvoiceStatus"
},
"currencyNo": {
"type": "string",
"nullable": true
},
"subTotal": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"positionsSubTotal": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"deliveryCostsSubTotal": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"purchaserResourceNo": {
"type": "string",
"nullable": true
},
"approverResourceNo": {
"type": "string",
"nullable": true
},
"purchaseOrderUnitNo": {
"type": "string",
"nullable": true
},
"purchaseOrderClassNo": {
"type": "string",
"nullable": true
},
"purchaseOrderClassName": {
"type": "string",
"nullable": true
},
"purchaseOrderDepartmentNo": {
"type": "string",
"nullable": true
},
"purchaseOrderDepartmentName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceResponse": {
"type": "object",
"properties": {
"invoiceNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"imInvoiceGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceReturnToDraft": {
"type": "object",
"properties": {
"response": {
"type": "string",
"nullable": true
},
"recipientNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceReversal": {
"type": "object",
"properties": {
"postingDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.ImInvoiceTotal": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"matched": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"difference": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.InvoiceChangeResponsibleArguments": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"massChangeResponsible": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.InvoiceChangeResponsibleResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
},
"imInvoice": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ImInvoice.ImInvoice"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ImInvoice.MoveToUnitIssue": {
"type": "object",
"properties": {
"objectNo": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Inspection.GroupCode": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"parentGroupCodeId": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Inspection.InspectionArea": {
"type": "object",
"properties": {
"inspectionAreaNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Inspection.InspectionJob": {
"type": "object",
"properties": {
"inspectionJobNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"groupCodeID": {
"type": "string",
"nullable": true
},
"groupCodeDescription": {
"type": "string",
"nullable": true
},
"referenceTo": {
"type": "string",
"nullable": true
},
"inspectionAreas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobInspectionArea"
},
"nullable": true
},
"dataOwner": {
"type": "integer",
"format": "int32"
},
"isOnOngoingInspectionList": {
"type": "boolean"
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Inspection.InspectionJobHistory": {
"type": "object",
"properties": {
"inspectionListGuid": {
"type": "string",
"format": "uuid"
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+InspectionJobHistoryStatus"
},
"comment": {
"type": "string",
"nullable": true
},
"lastComment": {
"type": "string",
"nullable": true
},
"closedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"inspectionJobNo": {
"type": "string",
"nullable": true
},
"inspectionJobText": {
"type": "string",
"nullable": true
},
"inspectionListNo": {
"type": "string",
"nullable": true
},
"hasLastClosedInspectionJobHistory": {
"type": "boolean"
},
"ratingTypeValueGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"lastRatingTypeLabel": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistoryDocument"
},
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Inspection.InspectionJobHistoryDocument": {
"type": "object",
"properties": {
"inspectionJobHistoryGuid": {
"type": "string",
"format": "uuid"
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Inspection.InspectionJobInspectionArea": {
"type": "object",
"properties": {
"inspectionJobGuid": {
"type": "string",
"format": "uuid"
},
"inspectionAreaNo": {
"type": "string",
"nullable": true
},
"inspectionAreaName": {
"type": "string",
"nullable": true
},
"inspectionJobNo": {
"type": "string",
"nullable": true
},
"inspectionJobText": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Inspection.InspectionList": {
"type": "object",
"properties": {
"inspectionListNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+InspectionListStatus"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"inspectionJobHistoryList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionJobHistory"
},
"nullable": true
},
"surveyors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListSurveyor"
},
"nullable": true
},
"ratingTypeValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Inspection.InspectionListActualRatingTypeValue"
},
"nullable": true
},
"inspectionPlace": {
"type": "string",
"nullable": true
},
"inspectionListTypeNo": {
"type": "string",
"nullable": true
},
"inspectionListTypeName": {
"type": "string",
"nullable": true
},
"inspectionListTypeGuid": {
"type": "string",
"format": "uuid"
},
"operationDuringInspectionType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+InspectionListOperationDuringInspectionType"
},
"generalComments": {
"type": "string",
"nullable": true
},
"lastPortStateControlInspectionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastPortStateControlInspectionPlace": {
"type": "string",
"nullable": true
},
"lastPortStateDeficienciesCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastPortStateOutstandingDeficienciesCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastCompanyInspectionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastCompanyInspectionPlace": {
"type": "string",
"nullable": true
},
"lastCompanyObservationsCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastCompanyOutstandingObservationsCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastCompanyAuditDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastCompanyAuditPlace": {
"type": "string",
"nullable": true
},
"lastCompanyAuditNonConformitiesCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastCompanyAuditNonConformitiesObservationsCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastCompanyAuditOutstandingNonConformitiesCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastCompanyAuditOutstandingNonConformitiesObservationsCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ratingTypeGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"ratingTypeNo": {
"type": "string",
"nullable": true
},
"ratingTypeDescription": {
"type": "string",
"nullable": true
},
"ratingTypeDisplay": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+RatingTypeDisplay"
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Inspection.InspectionListActualRatingTypeValue": {
"type": "object",
"properties": {
"inspectionListNo": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"requiresComment": {
"type": "boolean",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Inspection.InspectionListSurveyor": {
"type": "object",
"properties": {
"inspectionListGuid": {
"type": "string",
"format": "uuid"
},
"surveyorNo": {
"type": "string",
"nullable": true
},
"surveyorName": {
"type": "string",
"nullable": true
},
"inspectionListNo": {
"type": "string",
"nullable": true
},
"inspectionListName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Inspection.InspectionListType": {
"type": "object",
"properties": {
"inspectionListTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.Item": {
"type": "object",
"properties": {
"dataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"itemNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"expireDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"critical": {
"type": "boolean",
"nullable": true
},
"certificate": {
"type": "boolean",
"nullable": true
},
"trackExpiry": {
"type": "boolean",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"standardPrice": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"measureUnitName": {
"type": "string",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"itemTypeName": {
"type": "string",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"manufacturer": {
"type": "string",
"nullable": true
},
"referenceNo": {
"type": "string",
"nullable": true
},
"drawingNo": {
"type": "string",
"nullable": true
},
"drawingPosNo": {
"type": "string",
"nullable": true
},
"referencePosNo": {
"type": "string",
"nullable": true
},
"hsCodeNo": {
"type": "string",
"nullable": true
},
"typeNo": {
"type": "string",
"nullable": true
},
"classification": {
"type": "string",
"nullable": true
},
"standardNo": {
"type": "string",
"nullable": true
},
"dimension": {
"type": "string",
"nullable": true
},
"hsWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"criticalRemark": {
"type": "string",
"nullable": true
},
"lowOnStock": {
"type": "boolean",
"nullable": true
},
"stock": {
"type": "number",
"format": "double",
"nullable": true
},
"stockValue": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"warehouseNos": {
"type": "string",
"nullable": true
},
"warehouseNames": {
"type": "string",
"nullable": true
},
"locationNos": {
"type": "string",
"nullable": true
},
"locationNames": {
"type": "string",
"nullable": true
},
"itemPhotoNo": {
"type": "string",
"nullable": true
},
"itemPhotoDescription": {
"type": "string",
"nullable": true
},
"itemGroupNos": {
"type": "string",
"nullable": true
},
"itemGroupNames": {
"type": "string",
"nullable": true
},
"supplierItemNos": {
"type": "string",
"nullable": true
},
"supplierItemDescriptions": {
"type": "string",
"nullable": true
},
"componentNos": {
"type": "string",
"nullable": true
},
"standardSupplierItemNo": {
"type": "string",
"nullable": true
},
"trackedItem": {
"type": "boolean"
},
"qrCode": {
"type": "string",
"nullable": true
},
"disallowManualStockAdjustment": {
"type": "boolean"
},
"standardSupplierNo": {
"type": "string",
"nullable": true
},
"standardSupplierName": {
"type": "string",
"nullable": true
},
"orderedQuantity": {
"type": "number",
"format": "double"
},
"internalRemark": {
"type": "string",
"nullable": true
},
"manufacturerNo": {
"type": "string",
"nullable": true
},
"manufacturerName": {
"type": "string",
"nullable": true
},
"technicalAccountNo": {
"type": "string",
"nullable": true
},
"technicalAccountName": {
"type": "string",
"nullable": true
},
"taxCodeNo": {
"type": "string",
"nullable": true
},
"taxCodeName": {
"type": "string",
"nullable": true
},
"standardSupplierMinimumOrderQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"standardSupplierPackSize": {
"type": "number",
"format": "double",
"nullable": true
},
"customProperties": {
"nullable": true
},
"externalReference1": {
"type": "string",
"nullable": true
},
"webhookLogStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebhookLogStatus"
},
"warehouses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemWarehouse"
},
"nullable": true
},
"suppliers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplier"
},
"nullable": true
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.ComponentItem"
},
"nullable": true
},
"itemGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemItemGroup"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemDocument"
},
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemUnit"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemDocument": {
"type": "object",
"properties": {
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemGroup": {
"type": "object",
"properties": {
"dataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"itemGroupNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"parentItemGroupNo": {
"type": "string",
"nullable": true
},
"parentItemGroupName": {
"type": "string",
"nullable": true
},
"hasSubGroups": {
"type": "boolean"
},
"selectedUnitNo": {
"type": "string",
"nullable": true
},
"selectedOnUnit": {
"type": "boolean"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemItemGroup": {
"type": "object",
"properties": {
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"itemGroupNo": {
"type": "string",
"nullable": true
},
"itemGroupName": {
"type": "string",
"nullable": true
},
"itemGroupUnitNo": {
"type": "string",
"nullable": true
},
"itemGroupUnitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemSupplier": {
"type": "object",
"properties": {
"itemGuid": {
"type": "string",
"format": "uuid"
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"standardSupplier": {
"type": "boolean"
},
"supplierItemNo": {
"type": "string",
"nullable": true
},
"supplierItemDescription": {
"type": "string",
"nullable": true
},
"deliveryDays": {
"type": "integer",
"format": "int32"
},
"currentPrice": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"currentDiscount": {
"type": "number",
"format": "double",
"nullable": true
},
"itemSupplierInactive": {
"type": "boolean"
},
"minimumOrderQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"packSize": {
"type": "number",
"format": "double",
"nullable": true
},
"ports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPort"
},
"nullable": true
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPrice"
},
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemSupplierPort": {
"type": "object",
"properties": {
"itemSupplierGuid": {
"type": "string",
"format": "uuid"
},
"itemSupplierNo": {
"type": "string",
"nullable": true
},
"itemSupplierDescription": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"portCodeNo": {
"type": "string",
"nullable": true
},
"portName": {
"type": "string",
"nullable": true
},
"standardPort": {
"type": "boolean",
"nullable": true
},
"currentPrice": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"currentPriceStandardCurrency": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemSupplierPortPrice"
},
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemSupplierPortPrice": {
"type": "object",
"properties": {
"itemSupplierPortGuid": {
"type": "string",
"format": "uuid"
},
"portCodeNo": {
"type": "string",
"nullable": true
},
"portName": {
"type": "string",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"priceStandardCurrency": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expiryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemSupplierPrice": {
"type": "object",
"properties": {
"itemSupplierGuid": {
"type": "string",
"format": "uuid"
},
"itemSupplierNo": {
"type": "string",
"nullable": true
},
"itemSupplierDescription": {
"type": "string",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"netPrice": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"discount": {
"type": "number",
"format": "double",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expiryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"priceNettoStandardCurrency": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemTreeNode": {
"type": "object",
"properties": {
"hasChildren": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"visibleKey": {
"type": "string",
"nullable": true
},
"parentVisibleKey": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNodeType"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.ItemTreeNode"
},
"nullable": true
},
"hasParent": {
"type": "boolean",
"readOnly": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemTreeNodeType": {
"enum": [
"Item",
"ItemGroup",
"ItemSupplier"
],
"type": "string"
},
"SerticaWebApi.Models.Item.ItemType": {
"type": "object",
"properties": {
"itemTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemUnit": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"inactiveUnit": {
"type": "boolean"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemWarehouse": {
"type": "object",
"properties": {
"warehouseNo": {
"type": "string",
"nullable": true
},
"warehouseName": {
"type": "string",
"nullable": true
},
"standardWarehouse": {
"type": "boolean",
"nullable": true
},
"locationNo": {
"type": "string",
"nullable": true
},
"locationName": {
"type": "string",
"nullable": true
},
"stock": {
"type": "number",
"format": "double",
"nullable": true
},
"maximumStock": {
"type": "number",
"format": "double",
"nullable": true
},
"minimumStock": {
"type": "number",
"format": "double",
"nullable": true
},
"stockValue": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"qrCode": {
"type": "string",
"nullable": true
},
"standardCurrency": {
"type": "string",
"nullable": true
},
"itemCurrency": {
"type": "string",
"nullable": true
},
"lowOnStock": {
"type": "boolean",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"itemUnitNo": {
"type": "string",
"nullable": true
},
"itemUnitName": {
"type": "string",
"nullable": true
},
"itemGuid": {
"type": "string",
"format": "uuid"
},
"standardSupplierItemNo": {
"type": "string",
"nullable": true
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"warehouseNoNameStructure": {
"type": "string",
"nullable": true
},
"lastManualStockAdjustment": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Item.ItemWarehouseHistory": {
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"historyDate": {
"type": "string",
"format": "date-time"
},
"historyType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SparePartWarehouseHistoryType"
},
"stockQuantityAfterTransaction": {
"type": "number",
"format": "double"
},
"itemWarehouseGuid": {
"type": "string",
"format": "uuid"
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"warehouseNo": {
"type": "string",
"nullable": true
},
"warehouseName": {
"type": "string",
"nullable": true
},
"locationNo": {
"type": "string",
"nullable": true
},
"locationName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection": {
"type": "object",
"properties": {
"dataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"itemGroupGuid": {
"type": "string",
"format": "uuid"
},
"unitItemGroupGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitItemGroupLiveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"hasChildren": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"itemGroupText": {
"type": "string",
"nullable": true
},
"itemGroupNo": {
"type": "string",
"nullable": true
},
"parentVisibleKey": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"selected": {
"type": "boolean"
},
"selectedUnitNo": {
"type": "string",
"nullable": true
},
"selectedByNo": {
"type": "string",
"nullable": true
},
"selectedByName": {
"type": "string",
"nullable": true
},
"selectedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemGroupSelectionTree.ItemGroupSelection"
},
"nullable": true
},
"hasParent": {
"type": "boolean",
"readOnly": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode": {
"type": "object",
"properties": {
"hasChildren": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"visibleKey": {
"type": "string",
"nullable": true
},
"parentVisibleKey": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"warehouseNo": {
"type": "string",
"nullable": true
},
"warehouseName": {
"type": "string",
"nullable": true
},
"locationNo": {
"type": "string",
"nullable": true
},
"locationName": {
"type": "string",
"nullable": true
},
"qrCode": {
"type": "string",
"nullable": true
},
"standardSupplierItemNo": {
"type": "string",
"nullable": true
},
"stock": {
"type": "number",
"format": "double",
"nullable": true
},
"warehouseNoNameStructure": {
"type": "string",
"nullable": true
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNodeType"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNode"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ItemLocationTree.ItemLocationTreeNodeType": {
"enum": [
"Warehouse",
"ItemLocation",
"Item"
],
"type": "string"
},
"SerticaWebApi.Models.Job.Job": {
"type": "object",
"properties": {
"jobNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nextDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"jobInstanceGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"classification": {
"type": "string",
"nullable": true
},
"criticalEquipment": {
"type": "boolean"
},
"originalNextDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"originalEvents": {
"type": "number",
"format": "double",
"nullable": true
},
"teamNo": {
"type": "string",
"nullable": true
},
"maxExceedingDays": {
"type": "integer",
"format": "int32"
},
"overdueDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"responsibleUserNo": {
"type": "string",
"nullable": true
},
"responsibleUserName": {
"type": "string",
"nullable": true
},
"shortComment": {
"type": "string",
"nullable": true
},
"componentLocationNo": {
"type": "string",
"nullable": true
},
"componentLocationName": {
"type": "string",
"nullable": true
},
"componentSystemNo": {
"type": "string",
"nullable": true
},
"priorityNo": {
"type": "string",
"nullable": true
},
"priorityName": {
"type": "string",
"nullable": true
},
"lastDoneDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastAllowedDoneDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"statutoryNo": {
"type": "string",
"nullable": true
},
"statutoryName": {
"type": "string",
"nullable": true
},
"activatedByNo": {
"type": "string",
"nullable": true
},
"activatedByName": {
"type": "string",
"nullable": true
},
"nextCounterValue": {
"type": "number",
"format": "double",
"nullable": true
},
"remainingValueToNextCounterValue": {
"type": "number",
"format": "double",
"nullable": true
},
"triggerFrequencyShortDescription": {
"type": "string",
"nullable": true
},
"classCodeNo": {
"type": "string",
"nullable": true
},
"classCodeName": {
"type": "string",
"nullable": true
},
"classRelated": {
"type": "boolean"
},
"technicalFile": {
"type": "boolean"
},
"budgetCostEstimate": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"resourcesAsString": {
"type": "string",
"nullable": true
},
"resourceNamesAsString": {
"type": "string",
"nullable": true
},
"postponeRemark": {
"type": "string",
"nullable": true
},
"jobPostponementStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobInstancePostponementStatus"
},
"isActivated": {
"type": "boolean"
},
"isIdle": {
"type": "boolean"
},
"isPostponed": {
"type": "boolean"
},
"isOverdue": {
"type": "boolean"
},
"estimatedHours": {
"type": "number",
"format": "double"
},
"estimatedCosts": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"standardCurrency": {
"type": "string",
"nullable": true
},
"activeTriggerDescription": {
"type": "string",
"nullable": true
},
"activeTriggerType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TriggerType"
},
"openJobHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"jobGroupsAsString": {
"type": "string",
"nullable": true
},
"jobGroupNamesAsString": {
"type": "string",
"nullable": true
},
"jobNotificationMailTemplatesAsString": {
"type": "string",
"nullable": true
},
"jobNotificationRecipientsAsString": {
"type": "string",
"nullable": true
},
"triggerTypesAsString": {
"type": "string",
"nullable": true
},
"componentNoStructure": {
"type": "string",
"nullable": true
},
"componentNameStructure": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"formTemplatesAsString": {
"type": "string",
"nullable": true
},
"formTemplateNamesAsString": {
"type": "string",
"nullable": true
},
"isMainJob": {
"type": "boolean",
"nullable": true
},
"mainJobNo": {
"type": "string",
"nullable": true
},
"mainJobName": {
"type": "string",
"nullable": true
},
"jobOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobRequestNo": {
"type": "string",
"nullable": true
},
"logbookEventNo": {
"type": "string",
"nullable": true
},
"gpsLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"gpsLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"proceduresAsString": {
"type": "string",
"nullable": true
},
"procedureNamesAsString": {
"type": "string",
"nullable": true
},
"isPartOfJobSequence": {
"type": "boolean",
"nullable": true
},
"componentGpsLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"componentGpsLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseOrders": {
"type": "string",
"nullable": true
},
"jobSequenceNo": {
"type": "string",
"nullable": true
},
"jobSequenceName": {
"type": "string",
"nullable": true
},
"isNextJobInSequence": {
"type": "boolean"
},
"postponementReasonNo": {
"type": "string",
"nullable": true
},
"postponementReasonDescription": {
"type": "string",
"nullable": true
},
"certificateNo": {
"type": "string",
"nullable": true
},
"certificateName": {
"type": "string",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"assigneesAsString": {
"type": "string",
"nullable": true
},
"assigneeNamesAsString": {
"type": "string",
"nullable": true
},
"customProperties": {
"nullable": true
},
"defectJob": {
"type": "boolean",
"nullable": true
},
"hasOnlyRunOnceTrigger": {
"type": "boolean",
"nullable": true
},
"webhookLogStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebhookLogStatus"
},
"readDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"acknowledgeDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"mdmUniqueMainJob": {
"type": "boolean"
},
"hasJobFormTemplateActivation": {
"type": "boolean",
"nullable": true
},
"isJobFormTemplateActivationApproved": {
"type": "boolean",
"nullable": true
},
"hasJobFormTemplateCompletion": {
"type": "boolean",
"nullable": true
},
"isJobFormTemplateCompletionApproved": {
"type": "boolean",
"nullable": true
},
"disabled": {
"type": "boolean",
"nullable": true
},
"componentDisabled": {
"type": "boolean",
"nullable": true
},
"disabledDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"componentDisabledDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"mitigatingMeasures": {
"type": "string",
"nullable": true
},
"actionPlan": {
"type": "string",
"nullable": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobItem"
},
"nullable": true
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobResource"
},
"nullable": true
},
"procedures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobProcedure"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDocument"
},
"nullable": true
},
"triggers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobTrigger"
},
"nullable": true
},
"jobGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobJobGroup"
},
"nullable": true
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobNotification"
},
"nullable": true
},
"formTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFormTemplate"
},
"nullable": true
},
"relatedJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
},
"nullable": true
},
"assignees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobAssignee"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobActivationMessage": {
"type": "object",
"properties": {
"selected": {
"type": "boolean"
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"openJobHistoryGuid": {
"type": "string",
"format": "uuid"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobActivationIssue"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobActivationResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobActivationMessage"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobAssignee": {
"type": "object",
"properties": {
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"jobUnitNo": {
"type": "string",
"nullable": true
},
"allDay": {
"type": "boolean",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"componentUnitNo": {
"type": "string",
"nullable": true
},
"nextDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"highlight": {
"type": "boolean",
"nullable": true
},
"windowsUserName": {
"type": "string",
"nullable": true
},
"isJobOverdue": {
"type": "boolean"
},
"jobOverdueDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isJobActivated": {
"type": "boolean"
},
"isJobIdle": {
"type": "boolean"
},
"isJobPostponed": {
"type": "boolean"
},
"externalReference": {
"type": "string",
"nullable": true
},
"jobEstimatedHours": {
"type": "number",
"format": "double"
},
"lastAllowedDoneDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobDeactivationMessage": {
"type": "object",
"properties": {
"selected": {
"type": "boolean"
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDeactivationIssue"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobDeactivationResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDeactivationMessage"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobDisableResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobDisablerMessage"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobDisablerMessage": {
"type": "object",
"properties": {
"selected": {
"type": "boolean"
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableIssue"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobDocument": {
"type": "object",
"properties": {
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobFinalizationMessage": {
"type": "object",
"properties": {
"selected": {
"type": "boolean"
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobFinalizationIssue"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobFinalizationResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.JobFinalizationMessage"
},
"nullable": true,
"readOnly": true
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobFormTemplate": {
"type": "object",
"properties": {
"activation": {
"type": "boolean"
},
"completion": {
"type": "boolean"
},
"jobGuid": {
"type": "string",
"format": "uuid"
},
"jobNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"formGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"formNo": {
"type": "string",
"nullable": true
},
"formSubject": {
"type": "string",
"nullable": true
},
"formStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormStatus"
},
"serticaFormUnitNo": {
"type": "string",
"nullable": true
},
"jobFormTemplateDefaultAction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobFormTemplateDefaultAction"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobItem": {
"type": "object",
"properties": {
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"itemStock": {
"type": "number",
"format": "double",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"warehouseNo": {
"type": "string",
"nullable": true
},
"warehouseName": {
"type": "string",
"nullable": true
},
"stockOnWarehouse": {
"type": "number",
"format": "double",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"itemLocationNo": {
"type": "string",
"nullable": true
},
"itemLocationName": {
"type": "string",
"nullable": true
},
"stockOnLocation": {
"type": "number",
"format": "double",
"nullable": true
},
"currentStock": {
"type": "number",
"format": "double",
"nullable": true
},
"jobUnitNo": {
"type": "string",
"nullable": true
},
"jobUnitName": {
"type": "string",
"nullable": true
},
"itemUnitNo": {
"type": "string",
"nullable": true
},
"itemUnitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobJobGroup": {
"type": "object",
"properties": {
"jobGroupNo": {
"type": "string",
"nullable": true
},
"jobGroupName": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobMail": {
"type": "object",
"properties": {
"includeExternalFinalizeLink": {
"type": "boolean"
},
"externalFinalizeLink": {
"type": "string",
"nullable": true
},
"recipient": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"documentsToAttach": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMailAttachment"
},
"nullable": true
},
"sendCopy": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobMoveInfo": {
"type": "object",
"properties": {
"componentNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobNotification": {
"type": "object",
"properties": {
"days": {
"type": "integer",
"format": "int32"
},
"daysDirection": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.JobNotificationDaysDirection"
},
"jobMailTemplateNo": {
"type": "string",
"nullable": true
},
"recipients": {
"type": "string",
"nullable": true
},
"dateSent": {
"type": "string",
"format": "date-time",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobPlanningUpdateResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"readOnly": true
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobPostponementInfo": {
"type": "object",
"properties": {
"postponementReasonNo": {
"type": "string",
"nullable": true
},
"nextDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nextCounterValue": {
"type": "number",
"format": "double",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobProcedure": {
"type": "object",
"properties": {
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"procedureNo": {
"type": "string",
"nullable": true
},
"procedureName": {
"type": "string",
"nullable": true
},
"procedureText": {
"type": "string",
"nullable": true
},
"hasDocuments": {
"type": "boolean"
},
"unitNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobResource": {
"type": "object",
"properties": {
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"resourceRate": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"totalCosts": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"manhour": {
"type": "number",
"format": "double",
"nullable": true
},
"externalCosts": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.JobTrigger": {
"type": "object",
"properties": {
"triggerType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.TriggerType"
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"nextDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"planningType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.PlanningType"
},
"frequence": {
"type": "number",
"format": "double"
},
"longDescription": {
"type": "string",
"nullable": true
},
"recurringType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.RecurrenceType"
},
"every": {
"type": "integer",
"format": "int32",
"default": 0,
"nullable": true
},
"everyWeekday": {
"type": "boolean",
"nullable": true
},
"monday": {
"type": "boolean",
"nullable": true
},
"tuesday": {
"type": "boolean",
"nullable": true
},
"wednesday": {
"type": "boolean",
"nullable": true
},
"thursday": {
"type": "boolean",
"nullable": true
},
"friday": {
"type": "boolean",
"nullable": true
},
"saturday": {
"type": "boolean",
"nullable": true
},
"sunday": {
"type": "boolean",
"nullable": true
},
"dayOfMonth": {
"type": "integer",
"format": "int32",
"default": 0,
"nullable": true
},
"ordinal": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.OrdinalNumbers"
},
"month": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Months"
},
"useFloatingFixed": {
"type": "boolean",
"nullable": true
},
"seasonal": {
"type": "boolean"
},
"seasonStartDay": {
"type": "integer",
"format": "int32",
"nullable": true
},
"seasonStartMonth": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Months"
},
"seasonEndDay": {
"type": "integer",
"format": "int32",
"nullable": true
},
"seasonEndMonth": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Months"
},
"componentCounterRelationGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"counterNo": {
"type": "string",
"nullable": true
},
"counterName": {
"type": "string",
"nullable": true
},
"counterFrequence": {
"type": "number",
"format": "double",
"nullable": true
},
"counterStart": {
"type": "number",
"format": "double",
"nullable": true
},
"postponedCounterStart": {
"type": "number",
"format": "double",
"nullable": true
},
"nextRunValue": {
"type": "number",
"format": "double",
"nullable": true
},
"componentCounterEstimatedNow": {
"type": "number",
"format": "double",
"nullable": true
},
"measureGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"measureNo": {
"type": "string",
"nullable": true
},
"measureName": {
"type": "string",
"nullable": true
},
"measureTriggerType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.MeasureTriggerType"
},
"nominal": {
"type": "number",
"format": "double",
"nullable": true
},
"highLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"lowLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"deviationPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"highLimitNumberOfExceedings": {
"type": "integer",
"format": "int32",
"nullable": true
},
"highLimitLatestNoOfDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lowLimitNumberOfExceedings": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lowLimitLatestNoOfDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"averageOverReadings": {
"type": "integer",
"format": "int32",
"nullable": true
},
"predictionValue": {
"type": "number",
"format": "double",
"nullable": true
},
"dockListGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"dockListNo": {
"type": "string",
"nullable": true
},
"dockListDescription": {
"type": "string",
"nullable": true
},
"opcMachineName": {
"type": "string",
"nullable": true
},
"opcServerName": {
"type": "string",
"nullable": true
},
"opcItemId": {
"type": "string",
"nullable": true
},
"opcActive": {
"type": "boolean",
"nullable": true
},
"opcItemIDAck": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.MeasureTriggerType": {
"enum": [
"Limits",
"Deviation_Percent",
"DeviationFromAverage",
"Prediction"
],
"type": "string"
},
"SerticaWebApi.Models.Job.Months": {
"enum": [
"January",
"February",
"March",
"April",
"May",
"June",
"July",
"August",
"September",
"October",
"November",
"December"
],
"type": "string"
},
"SerticaWebApi.Models.Job.OrdinalNumbers": {
"enum": [
"First",
"Second",
"Third",
"Fourth",
"Last"
],
"type": "string"
},
"SerticaWebApi.Models.Job.PlanningType": {
"enum": [
"Floating",
"Fixed",
"FixedWhenOverdue",
"RunningMonthPlusFrequency"
],
"type": "string"
},
"SerticaWebApi.Models.Job.PostponementReason": {
"type": "object",
"properties": {
"postponementReasonNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Job.RecurrenceType": {
"enum": [
"Daily",
"Weekly",
"Monthly",
"Yearly"
],
"type": "string"
},
"SerticaWebApi.Models.Job.TriggerType": {
"enum": [
"AllTriggers",
"RunOnceTrigger",
"RecurringTrigger",
"CounterTrigger",
"MeasurementTrigger",
"DockTrigger",
"OPCAlarmTrigger",
"JobSequenceCalendarTrigger",
"JobSequenceCounterTrigger"
],
"type": "string"
},
"SerticaWebApi.Models.JobGroup.JobGroup": {
"type": "object",
"properties": {
"jobGroupNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"requireRemark": {
"type": "boolean"
},
"gracePeriod": {
"type": "integer",
"format": "int32"
},
"doNotShowInApp": {
"type": "boolean",
"nullable": true
},
"itemUsageMandatoryOnJobHistory": {
"type": "boolean",
"nullable": true
},
"acknowledgeMandatory": {
"type": "boolean",
"nullable": true
},
"formTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobGroup.JobGroupFormTemplate"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobGroup.JobGroupFormTemplate": {
"type": "object",
"properties": {
"activation": {
"type": "boolean"
},
"completion": {
"type": "boolean"
},
"jobGroupGuid": {
"type": "string",
"format": "uuid"
},
"jobGroupNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"jobGroupName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"jobFormTemplateDefaultAction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobFormTemplateDefaultAction"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobHistory.JobHistory": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryStatus"
},
"done": {
"type": "string",
"format": "date-time",
"nullable": true
},
"linkDate": {
"type": "string",
"format": "date-time"
},
"remark": {
"type": "string",
"nullable": true
},
"counterReading": {
"type": "number",
"format": "double",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"liveJobNo": {
"type": "string",
"nullable": true
},
"liveJobName": {
"type": "string",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"liveComponentNo": {
"type": "string",
"nullable": true
},
"liveComponentName": {
"type": "string",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"standardCurrency": {
"type": "string",
"nullable": true
},
"hours": {
"type": "number",
"format": "double"
},
"resourceCosts": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"itemCosts": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"totalCosts": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"resourcesAsString": {
"type": "string",
"nullable": true
},
"resourceNamesAsString": {
"type": "string",
"nullable": true
},
"jobGroupsAsString": {
"type": "string",
"nullable": true
},
"jobGroupNamesAsString": {
"type": "string",
"nullable": true
},
"postponeRemark": {
"type": "string",
"nullable": true
},
"isLatestJobHistory": {
"type": "boolean"
},
"componentNoStructure": {
"type": "string",
"nullable": true
},
"componentNameStructure": {
"type": "string",
"nullable": true
},
"jobHistoryTriggerType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TriggerType"
},
"nextDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"formTemplatesAsString": {
"type": "string",
"nullable": true
},
"formTemplateNamesAsString": {
"type": "string",
"nullable": true
},
"isMainJob": {
"type": "boolean",
"nullable": true
},
"mainJobNo": {
"type": "string",
"nullable": true
},
"mainJobName": {
"type": "string",
"nullable": true
},
"jobOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"acknowledged": {
"type": "boolean"
},
"acknowledgeMandatory": {
"type": "boolean"
},
"webhookLogStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebhookLogStatus"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResource"
},
"nullable": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryItem"
},
"nullable": true
},
"jobGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryJobGroup"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
},
"nullable": true
},
"formTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate"
},
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryResponse"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobHistory.JobHistoryDocument": {
"type": "object",
"properties": {
"jobHistoryGuid": {
"type": "string",
"format": "uuid"
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobHistory.JobHistoryFormTemplate": {
"type": "object",
"properties": {
"activation": {
"type": "boolean"
},
"completion": {
"type": "boolean"
},
"addedFromJob": {
"type": "boolean"
},
"jobHistoryGuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"jobHistoryLinkDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"formNo": {
"type": "string",
"nullable": true
},
"formSubject": {
"type": "string",
"nullable": true
},
"formStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FormStatus"
},
"serticaFormUnitNo": {
"type": "string",
"nullable": true
},
"jobFormTemplateDefaultAction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobFormTemplateDefaultAction"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobHistory.JobHistoryItem": {
"type": "object",
"properties": {
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"itemStock": {
"type": "number",
"format": "double",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"quantityFromOwnStock": {
"type": "number",
"format": "double",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"warehouseNo": {
"type": "string",
"nullable": true
},
"warehouseName": {
"type": "string",
"nullable": true
},
"stockOnWarehouse": {
"type": "number",
"format": "double",
"nullable": true
},
"jobHistoryGuid": {
"type": "string",
"format": "uuid"
},
"itemLocationNo": {
"type": "string",
"nullable": true
},
"itemLocationName": {
"type": "string",
"nullable": true
},
"stockOnLocation": {
"type": "number",
"format": "double",
"nullable": true
},
"currentStock": {
"type": "number",
"format": "double",
"nullable": true
},
"jobHistoryUnitNo": {
"type": "string",
"nullable": true
},
"jobHistoryUnitName": {
"type": "string",
"nullable": true
},
"itemUnitNo": {
"type": "string",
"nullable": true
},
"itemUnitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobHistory.JobHistoryJobGroup": {
"type": "object",
"properties": {
"jobGroupNo": {
"type": "string",
"nullable": true
},
"jobGroupName": {
"type": "string",
"nullable": true
},
"jobHistoryGuid": {
"type": "string",
"format": "uuid"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobHistory.JobHistoryResource": {
"type": "object",
"properties": {
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"resourceRate": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"totalCosts": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"manhour": {
"type": "number",
"format": "double",
"nullable": true
},
"externalCosts": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"jobHistoryGuid": {
"type": "string",
"format": "uuid"
},
"resourceDoneDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobHistory.JobHistoryResponse": {
"type": "object",
"properties": {
"jobHistoryGuid": {
"type": "string",
"format": "uuid"
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobHistory.JobHistoryStatus": {
"enum": [
"None",
"Open",
"Final"
],
"type": "string"
},
"SerticaWebApi.Models.JobHistoryDataEntryWeb.JobHistoryDataEntry": {
"type": "object",
"properties": {
"remark": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"nextDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"done": {
"type": "string",
"format": "date-time",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobHistory.JobHistoryDocument"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobMailTemplate.JobMailTemplate": {
"type": "object",
"properties": {
"jobMailTemplateNo": {
"type": "string",
"nullable": true
},
"body": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobRecommendation.JobRecommendation": {
"type": "object",
"properties": {
"jobRecommendationNo": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+JobRecommendationStatus"
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRecommendation.JobRecommendationDocument"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobRecommendation.JobRecommendationDocument": {
"type": "object",
"properties": {
"jobRecommendationNo": {
"type": "string",
"nullable": true
},
"jobRecommendationName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobRecommendation.JobRecommendationResponse": {
"type": "object",
"properties": {
"jobRecommendationNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobRequest.JobRequest": {
"type": "object",
"properties": {
"jobRequestNo": {
"type": "string",
"nullable": true
},
"jobRequestTemplateNo": {
"type": "string",
"nullable": true
},
"jobRequestTemplateCopy": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestTemplateView"
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestStatus"
},
"fieldValues": {
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"rejectRemark": {
"type": "string",
"nullable": true
},
"defectJob": {
"type": "boolean"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequest.JobRequestDocument"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobRequest.JobRequestDocument": {
"type": "object",
"properties": {
"jobRequestNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobRequestMailTemplate.JobRequestMailTemplate": {
"type": "object",
"properties": {
"jobRequestMailTemplateNo": {
"type": "string",
"nullable": true
},
"body": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplate": {
"type": "object",
"properties": {
"jobRequestTemplateNo": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"submitButtonText": {
"type": "string",
"nullable": true
},
"logoDocumentNo": {
"type": "string",
"nullable": true
},
"logoDocumentDescription": {
"type": "string",
"nullable": true
},
"usersAsString": {
"type": "string",
"nullable": true
},
"userNamesAsString": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestField"
},
"nullable": true
},
"mailTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateJobRequestMailTemplate"
},
"nullable": true
},
"notificationUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateNotificationUser"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateJobRequestMailTemplate": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobRequestModule.JobRequestStatus"
},
"jobRequestMailTemplateNo": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobRequestTemplate.JobRequestTemplateNotificationUser": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobSequence.JobSequence": {
"type": "object",
"properties": {
"jobSequenceNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"repeatSequence": {
"type": "boolean",
"nullable": true
},
"startValue": {
"type": "number",
"format": "double",
"nullable": true
},
"startValueUnit": {
"type": "string",
"nullable": true
},
"componentHasCounter": {
"type": "boolean",
"nullable": true
},
"nextJobNo": {
"type": "string",
"nullable": true
},
"nextJobName": {
"type": "string",
"nullable": true
},
"nextJobDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequenceJob"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobSequence.JobSequenceJob": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobSequenceNo": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"triggerType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TriggerType"
},
"triggerSettings": {
"type": "string",
"nullable": true
},
"triggerGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"nextDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"postponeToDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"postponeToCounterValue": {
"type": "number",
"format": "double",
"nullable": true
},
"isNextJob": {
"type": "boolean",
"nullable": true
},
"trigger": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobSequence.JobSequenceJobTrigger"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobSequence.JobSequenceJobTrigger": {
"type": "object",
"properties": {
"jobNo": {
"type": "string",
"nullable": true
},
"triggerType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TriggerType"
},
"frequence": {
"type": "number",
"format": "double"
},
"recurringType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+RecurrenceType"
},
"counterFrequence": {
"type": "number",
"format": "double",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobTemplate.JobTemplate": {
"type": "object",
"properties": {
"templateNo": {
"type": "string",
"nullable": true
},
"templateName": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"jobText": {
"type": "string",
"nullable": true
},
"componentTypeNos": {
"type": "string",
"nullable": true
},
"jobGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplateJobGroup"
},
"nullable": true
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.JobTemplate.JobTemplateResource"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobTemplate.JobTemplateJobGroup": {
"type": "object",
"properties": {
"jobGroupNo": {
"type": "string",
"nullable": true
},
"jobGroupName": {
"type": "string",
"nullable": true
},
"jobTemplateGuid": {
"type": "string",
"format": "uuid"
},
"templateNo": {
"type": "string",
"nullable": true
},
"templateName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.JobTemplate.JobTemplateResource": {
"type": "object",
"properties": {
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"jobTemplateGuid": {
"type": "string",
"format": "uuid"
},
"templateNo": {
"type": "string",
"nullable": true
},
"templateName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.License.License": {
"type": "object",
"properties": {
"serticaVersion": {
"type": "string",
"nullable": true
},
"fleetManagementRole": {
"$ref": "#/components/schemas/Logimatic.StandardFunctionsCS.FleetManagementRole"
},
"fleetManagement": {
"type": "boolean"
},
"iosAppEnabled": {
"type": "integer",
"format": "int32"
},
"serticaForms": {
"type": "boolean"
},
"inextiaForms": {
"type": "boolean"
},
"maintenanceApp": {
"type": "integer",
"format": "int32"
},
"jobRelations": {
"type": "boolean"
},
"useExpectedFaultCode": {
"type": "boolean"
},
"forms": {
"type": "boolean"
},
"formsOnJob": {
"type": "boolean"
},
"sparePartLocation": {
"type": "boolean"
},
"customObjectProperties": {
"type": "boolean"
},
"shipDexIntegration": {
"type": "boolean"
},
"inextiaMenuUserrights": {
"type": "boolean"
},
"managementSystemWeb": {
"type": "boolean"
},
"gpsCoordinates": {
"type": "boolean"
},
"inextiaJobRelations": {
"type": "boolean"
},
"genericJobRequestModule": {
"type": "boolean"
},
"jobSequence": {
"type": "boolean"
},
"jobSafetyModule": {
"type": "boolean"
},
"pdfPrintFromSERTICAApp": {
"type": "boolean"
},
"inextiaDocumentTree": {
"type": "boolean"
},
"inextiaDynamicLayout": {
"type": "boolean"
},
"jobHistoryDataEntryWeb": {
"type": "boolean"
},
"showJobsNearby": {
"type": "boolean"
},
"managementSystemOnJob": {
"type": "boolean"
},
"aiIntegration": {
"$ref": "#/components/schemas/Logimatic.StandardFunctionsCS.AIIntegrationFlag"
},
"inextiaGPSLocation": {
"type": "boolean"
},
"inextiaProcurement": {
"type": "boolean"
},
"inextiaFullProcurement": {
"type": "boolean"
},
"customerType": {
"$ref": "#/components/schemas/Logimatic.StandardFunctionsCS.CustomerType"
},
"multipleCompaniesOnUnit": {
"type": "boolean"
},
"dashboard": {
"type": "boolean"
},
"inextiaLogbook": {
"type": "boolean"
},
"googleMapsKey": {
"type": "string",
"nullable": true
},
"approvalWeb": {
"type": "boolean"
},
"userRoles": {
"type": "boolean"
},
"managementSystemReadLogging": {
"type": "boolean"
},
"webCertificateHandling": {
"type": "boolean"
},
"webDashboards": {
"type": "boolean"
},
"unitLength": {
"type": "integer",
"format": "int32"
},
"webVesselReportingSystem": {
"type": "boolean"
},
"inextiaAnalytics": {
"type": "boolean"
},
"azureADLogin": {
"type": "boolean"
},
"webOutlookCalendarIntegration": {
"type": "boolean"
},
"tobitInterface": {
"type": "boolean"
},
"shipServInterface": {
"type": "boolean"
},
"seaProcInterface": {
"type": "boolean"
},
"connectProcurementIntegration": {
"type": "boolean"
},
"openTRANSInterface": {
"type": "boolean"
},
"source2Sea": {
"type": "boolean"
},
"calculatePOPortPrices": {
"type": "boolean"
},
"integrationMode": {
"$ref": "#/components/schemas/Logimatic.StandardFunctionsCS.IntegrationMode"
},
"punchoutIntegration": {
"type": "boolean"
},
"spireAisIntegration": {
"type": "boolean"
},
"invoiceManagement": {
"type": "boolean"
},
"procurementDistributionModule": {
"type": "boolean"
},
"itemTypesOnHeader": {
"type": "boolean"
},
"procurementQA": {
"type": "boolean"
},
"webhooksIntegration": {
"type": "boolean"
},
"sertica5WebExtensionsAnalytics": {
"type": "boolean"
},
"sertica5WebExtensionsTaskList": {
"type": "boolean"
},
"sertica5WebExtensionsDocumentManagement": {
"type": "boolean"
},
"inextiaJobEmailNotification": {
"type": "boolean"
},
"inextiaDocumentEmailNotification": {
"type": "boolean"
},
"accountLayout": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AccountLayout"
},
"procurementApprovalSetup": {
"type": "boolean"
},
"inextiaFormsFileBased": {
"type": "boolean"
},
"dataWarehouse": {
"type": "boolean"
},
"electronicLogbook": {
"type": "boolean"
},
"oilRecordBook": {
"type": "boolean"
},
"garbageRecordBook": {
"type": "boolean"
},
"ozoneDepletingSubstancesRecordBook": {
"type": "boolean"
},
"ballastRecordBook": {
"type": "boolean"
},
"testVersion": {
"type": "boolean"
},
"testVersionText": {
"type": "string",
"nullable": true
},
"maxExceedingDaysOnJob": {
"type": "boolean"
},
"maintenance": {
"type": "boolean"
},
"masterDataManagementWeb": {
"type": "boolean"
},
"acknowledgeJobHistories": {
"type": "boolean"
},
"defectJob": {
"type": "boolean"
},
"webExternalCalendarIntegration": {
"type": "boolean"
},
"enableSectionGroupInFleet": {
"type": "boolean"
},
"sectionGroupsDisabled": {
"type": "boolean"
},
"maxFileSize": {
"type": "integer",
"format": "int64"
},
"priorityUserDefined": {
"type": "boolean"
},
"useUtcDates": {
"type": "boolean"
},
"webhooksMode": {
"$ref": "#/components/schemas/Logimatic.StandardFunctionsCS.WebhooksMode"
},
"scheduledWebhooks": {
"type": "boolean"
},
"mailAccountOnUnitCompany": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Link": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponent, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponent"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponentDocument, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponentDocument"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponentItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponentItem"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetDocument, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetDocument"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetItem"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetItemDocument, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetItemDocument"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJob, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJob"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJobDocument, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJobDocument"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJobItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJobItem"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[SerticaWebApi.Models.Component.Component, SerticaWebApi, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[SerticaWebApi.Models.Document.Document, SerticaWebApi, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Document.Document"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[SerticaWebApi.Models.Item.Item, SerticaWebApi, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Item.Item"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[SerticaWebApi.Models.Job.Job, SerticaWebApi, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"excelRow": {
"type": "integer",
"format": "int32"
},
"data": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Job.Job"
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"validationResultAsString": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LoadSheet.LoadSheetResult": {
"type": "object",
"properties": {
"loadSheetIsValid": {
"type": "boolean",
"readOnly": true
},
"isValid": {
"type": "boolean",
"readOnly": true
},
"loadSheetComponents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponent, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[SerticaWebApi.Models.Component.Component, SerticaWebApi, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"loadSheetJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJob, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[SerticaWebApi.Models.Job.Job, SerticaWebApi, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"loadSheetDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetDocument, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[SerticaWebApi.Models.Document.Document, SerticaWebApi, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"loadSheetComponentDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponentDocument, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"loadSheetJobDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJobDocument, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[SerticaWebApi.Models.Item.Item, SerticaWebApi, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"loadSheetItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"loadSheetComponentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetComponentItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"loadSheetJobItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetJobItem, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"loadSheetItemDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LoadSheet.LoadSheetData`1[[Logihold.BusinessObjects.Excel.LoadSheet.LoadSheetItemDocument, LogiholdBusinessObjects, Version=5.26.9.1, Culture=neutral, PublicKeyToken=null]]"
},
"nullable": true
},
"importComponents": {
"type": "boolean"
},
"importJobs": {
"type": "boolean"
},
"importDocuments": {
"type": "boolean"
},
"importComponentDocuments": {
"type": "boolean"
},
"importJobDocuments": {
"type": "boolean"
},
"importItems": {
"type": "boolean"
},
"importComponentItems": {
"type": "boolean"
},
"importJobItems": {
"type": "boolean"
},
"importItemDocuments": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Localization.CommunicationLanguage": {
"type": "object",
"properties": {
"communicationLanguageNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"localizationLanguageNo": {
"type": "string",
"nullable": true
},
"localizationLanguageText": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Localization.StandardTextLanguage": {
"type": "object",
"properties": {
"standardTextGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"standardTextNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"standardTextText": {
"type": "string",
"nullable": true,
"readOnly": true
},
"communicationLanguageNo": {
"type": "string",
"nullable": true
},
"communicationLanguageName": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"defaultText": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Localization.TranslationText": {
"type": "object",
"properties": {
"textId": {
"type": "integer",
"format": "int32"
},
"text": {
"type": "string",
"nullable": true
},
"shownText": {
"type": "string",
"nullable": true
},
"languageNo": {
"type": "string",
"nullable": true
},
"isTranslated": {
"type": "boolean",
"nullable": true
},
"translatedText": {
"type": "string",
"nullable": true
},
"translatedShownText": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LocalizationLanguage.LocalizationLanguage": {
"type": "object",
"properties": {
"languageNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"standard": {
"type": "boolean"
},
"parentLanguageGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"parentLanguageNo": {
"type": "string",
"nullable": true
},
"parentLanguageName": {
"type": "string",
"nullable": true
},
"locale": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LogbookEvent.LogbookEvent": {
"type": "object",
"properties": {
"eventNo": {
"type": "string",
"nullable": true
},
"dateOfEvent": {
"type": "string",
"format": "date-time"
},
"subject": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"defectJob": {
"type": "boolean"
},
"customProperties": {
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.LogbookEvent.LogbookEventDocument"
},
"nullable": true
},
"componentNoStructure": {
"type": "string",
"nullable": true
},
"componentNameStructure": {
"type": "string",
"nullable": true
},
"componentLocationNo": {
"type": "string",
"nullable": true
},
"componentLocationName": {
"type": "string",
"nullable": true
},
"hasAttachments": {
"type": "boolean"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.LogbookEvent.LogbookEventDocument": {
"type": "object",
"properties": {
"eventNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MailAccount.MailAccount": {
"type": "object",
"properties": {
"mailAccountNo": {
"type": "string",
"nullable": true
},
"useTLS": {
"type": "boolean",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"smtpHostName": {
"type": "string",
"nullable": true
},
"smtpUserAccount": {
"type": "string",
"nullable": true
},
"smtpUserPassword": {
"type": "string",
"nullable": true
},
"smtpPort": {
"type": "integer",
"format": "int32"
},
"smtpUseSsl": {
"type": "boolean",
"nullable": true
},
"smtpEmailAddress": {
"type": "string",
"nullable": true
},
"smtpDoNotUseLoginMethod": {
"type": "boolean",
"nullable": true
},
"smtpLoginMethod": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SMTPLoginMethod"
},
"smtpAuthenticationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SMTPAuthenticationType"
},
"smtpClientID": {
"type": "string",
"nullable": true
},
"smtpClientSecret": {
"type": "string",
"nullable": true
},
"hasSmtpClientSecret": {
"type": "boolean",
"nullable": true
},
"smtpClientScope": {
"type": "string",
"nullable": true
},
"smtpTenantID": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ApiChangeRequestApproveArguments": {
"type": "object",
"properties": {
"changeRequestWithOlderRevisionAnswer": {
"type": "boolean",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ApiPublishArguments": {
"type": "object",
"properties": {
"continueWhenUserAlreadyPublishing": {
"type": "boolean",
"nullable": true
},
"publishUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishUnit"
},
"nullable": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"authorizingUserNo": {
"type": "string",
"nullable": true
},
"publishMode": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.PublishMode"
},
"publishDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ApiPublishableDocument"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ApiPublishUnit": {
"type": "object",
"properties": {
"unitGuid": {
"type": "string",
"nullable": true
},
"publish": {
"type": "boolean"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"draft": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ApiPublishableDocument": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"nullable": true
},
"publish": {
"type": "boolean"
},
"documentType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystemPublisher+PublishableType"
},
"documentInfo": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"changeRequestNo": {
"type": "string",
"nullable": true
},
"affectedUnits": {
"type": "string",
"nullable": true
},
"documentFileOK": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ControlledCopy": {
"type": "object",
"properties": {
"copyNo": {
"type": "string",
"nullable": true
},
"responsible": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"copyType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ControlledCopyType"
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"managementSystemName": {
"type": "string",
"nullable": true
},
"assignedToNo": {
"type": "string",
"nullable": true
},
"assignedToName": {
"type": "string",
"nullable": true
},
"assignedToType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"exportStatus": {
"type": "boolean"
},
"revisionHistories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopyRevision"
},
"nullable": true
},
"controlledCopySections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ControlledCopySection"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ControlledCopyRevision": {
"type": "object",
"properties": {
"controlledCopyGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"controlledCopyNo": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revisionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"documentName": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"revisionPrintDocument": {
"type": "string",
"nullable": true
},
"emailRecipient": {
"type": "string",
"nullable": true
},
"emailSent": {
"type": "string",
"format": "date-time",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ControlledCopySection": {
"type": "object",
"properties": {
"managementSystemNo": {
"type": "string",
"nullable": true
},
"managementSystemUnitNo": {
"type": "string",
"nullable": true
},
"sectionUnitNo": {
"type": "string",
"nullable": true
},
"sectionNo": {
"type": "string",
"nullable": true
},
"sectionName": {
"type": "string",
"nullable": true
},
"sectionId": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystem": {
"type": "object",
"properties": {
"managementSystemNo": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"systemHeadLine": {
"type": "string",
"nullable": true
},
"documentCheckTitle": {
"type": "string",
"nullable": true
},
"startRevisionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"recentUpdateDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"enforceConfidentiality": {
"type": "boolean",
"nullable": true
},
"localizationLanguageNo": {
"type": "string",
"nullable": true
},
"localizationLanguageName": {
"type": "string",
"nullable": true
},
"formTemplateNo": {
"type": "string",
"nullable": true
},
"formTemplateName": {
"type": "string",
"nullable": true
},
"useFixedApprovalFlow": {
"type": "boolean"
},
"sourceNo": {
"type": "string",
"nullable": true
},
"sourceName": {
"type": "string",
"nullable": true
},
"criticalityNo": {
"type": "string",
"nullable": true
},
"criticalityName": {
"type": "string",
"nullable": true
},
"defaultPrinter": {
"type": "string",
"nullable": true
},
"pdfPath": {
"type": "string",
"nullable": true
},
"mainIndexTemplateNo": {
"type": "string",
"nullable": true
},
"mainIndexTemplateName": {
"type": "string",
"nullable": true
},
"mainIndexTopic": {
"type": "string",
"nullable": true
},
"minorChangeApproverNo": {
"type": "string",
"nullable": true
},
"minorChangeApproverName": {
"type": "string",
"nullable": true
},
"minorChangeApproverType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"sectionIndexTemplateNo": {
"type": "string",
"nullable": true
},
"sectionIndexTemplateName": {
"type": "string",
"nullable": true
},
"sectionIndexTopic": {
"type": "string",
"nullable": true
},
"rocTemplateNo": {
"type": "string",
"nullable": true
},
"rocTemplateName": {
"type": "string",
"nullable": true
},
"frontPageCoverNo": {
"type": "string",
"nullable": true
},
"frontPageCoverName": {
"type": "string",
"nullable": true
},
"portraitTemplateNo": {
"type": "string",
"nullable": true
},
"portraitTemplateName": {
"type": "string",
"nullable": true
},
"landscapeTemplateNo": {
"type": "string",
"nullable": true
},
"landscapeTemplateName": {
"type": "string",
"nullable": true
},
"lockedByUserNo": {
"type": "string",
"nullable": true
},
"lockedByUserName": {
"type": "string",
"nullable": true
},
"lockedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"availableForAI": {
"type": "boolean"
},
"hasActiveTask": {
"type": "boolean"
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemApprover"
},
"nullable": true
},
"confidentialities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemConfidentiality"
},
"nullable": true
},
"changeRequestUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemChangeRequestUser"
},
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit"
},
"nullable": true
},
"deletedUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemDeletedUnit"
},
"nullable": true
},
"acknowledgers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemAcknowledger"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemAcknowledger": {
"type": "object",
"properties": {
"managementSystemNo": {
"type": "string",
"nullable": true
},
"acknowledgerNo": {
"type": "string",
"nullable": true
},
"acknowledgerName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"sectionsAsString": {
"type": "string",
"nullable": true
},
"sections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemAcknowledgerSection"
},
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemAcknowledgerSection": {
"type": "object",
"properties": {
"managementSystemAcknowledgerGuid": {
"type": "string",
"format": "uuid"
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"acknowledgerNo": {
"type": "string",
"nullable": true
},
"acknowledgerName": {
"type": "string",
"nullable": true
},
"sectionID": {
"type": "string",
"nullable": true
},
"sectionNo": {
"type": "string",
"nullable": true
},
"sectionName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemApprover": {
"type": "object",
"properties": {
"managementSystemNo": {
"type": "string",
"nullable": true
},
"approvalOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"approverNo": {
"type": "string",
"nullable": true
},
"approverName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserDocument": {
"type": "object",
"properties": {
"documentNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"revisionNo": {
"type": "string",
"nullable": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"area": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"documentFileNo": {
"type": "string",
"nullable": true
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"wordsToHighlight": {
"type": "string",
"nullable": true
},
"isReadByCurrentUser": {
"type": "boolean",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserNodeType": {
"enum": [
"Section",
"Document"
],
"type": "string"
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode": {
"type": "object",
"properties": {
"hasChildren": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"visibleKey": {
"type": "string",
"nullable": true
},
"sortKey": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserNodeType"
},
"parentSectionGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"parentSectionNo": {
"type": "string",
"nullable": true
},
"parentSectionName": {
"type": "string",
"nullable": true
},
"isReadByCurrentUser": {
"type": "boolean",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystem.ManagementSystemBrowserTreeStructureNode"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemChangeRequestUser": {
"type": "object",
"properties": {
"managementSystemNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemConfidentiality": {
"type": "object",
"properties": {
"managementSystemNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemDeletedUnit": {
"type": "object",
"properties": {
"managementSystemGuid": {
"type": "string",
"format": "uuid"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"deletedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"deleteUserNo": {
"type": "string",
"nullable": true
},
"deleteUserName": {
"type": "string",
"nullable": true
},
"revisionAtDeletion": {
"type": "integer",
"format": "int32"
},
"deleteInProgress": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemDocument": {
"type": "object",
"properties": {
"documentNo": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"replaceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"firstPublishedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"area": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"documentFileName": {
"type": "string",
"nullable": true
},
"documentFileNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"managementSystemTitle": {
"type": "string",
"nullable": true
},
"managementSystemSectionNo": {
"type": "string",
"nullable": true
},
"managementSystemSectionName": {
"type": "string",
"nullable": true
},
"sectionId": {
"type": "string",
"nullable": true
},
"firstPublishUserNo": {
"type": "string",
"nullable": true
},
"firstPublishUserName": {
"type": "string",
"nullable": true
},
"revisedUserNo": {
"type": "string",
"nullable": true
},
"revisedUserName": {
"type": "string",
"nullable": true
},
"authorizedUserNo": {
"type": "string",
"nullable": true
},
"authorizedUserName": {
"type": "string",
"nullable": true
},
"managementSystemLocked": {
"type": "boolean"
},
"isInDraft": {
"type": "boolean"
},
"commonDocument": {
"type": "boolean",
"nullable": true
},
"pages": {
"type": "integer",
"format": "int32",
"nullable": true
},
"revisionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ManagementSystemDocumentStatus"
},
"doNotSendToPrinterInPublish": {
"type": "boolean"
},
"recentlyUpdated": {
"type": "boolean"
},
"finalApproverUserNo": {
"type": "string",
"nullable": true
},
"finalApproverUserName": {
"type": "string",
"nullable": true
},
"documentPreviewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"documentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit"
},
"nullable": true
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentApprover"
},
"nullable": true
},
"revisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentRevision"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemDocumentAcknowledgement": {
"type": "object",
"properties": {
"acknowledged": {
"type": "boolean",
"nullable": true
},
"acknowledgerUserNo": {
"type": "string",
"nullable": true
},
"acknowledgerUserName": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"firstPublishedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"replaceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"revisionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"managementSystemTitle": {
"type": "string",
"nullable": true
},
"managementSystemSectionNo": {
"type": "string",
"nullable": true
},
"managementSystemSectionName": {
"type": "string",
"nullable": true
},
"sectionId": {
"type": "string",
"nullable": true
},
"firstPublishUserNo": {
"type": "string",
"nullable": true
},
"firstPublishUserName": {
"type": "string",
"nullable": true
},
"documentFileNo": {
"type": "string",
"nullable": true
},
"documentFileName": {
"type": "string",
"nullable": true
},
"documentPreviewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"documentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemROC": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"revisionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"managementSystemName": {
"type": "string",
"nullable": true
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"managementSystemROCNo": {
"type": "string",
"nullable": true
},
"managementSystemGuid": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemROCDocument": {
"type": "object",
"properties": {
"managementSystemROCNo": {
"type": "string",
"nullable": true
},
"managementSystemDocumentNo": {
"type": "string",
"nullable": true
},
"managementSystemDocumentId": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ChangeRequestCause"
},
"changeRequestNo": {
"type": "string",
"nullable": true
},
"changeRequestDescription": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystem.ManagementSystemUnit": {
"type": "object",
"properties": {
"managementSystemGuid": {
"type": "string",
"format": "uuid"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"draft": {
"type": "boolean"
},
"approvedPlanDocumentNo": {
"type": "string",
"nullable": true
},
"allowBypassApproval": {
"type": "boolean"
},
"approvedPlanPassword": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentApprover": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"nullable": true
},
"approvalOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"approverNo": {
"type": "string",
"nullable": true
},
"approverName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentRevision": {
"type": "object",
"properties": {
"documentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"documentID": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revisionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"replaceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"authorizedUserNo": {
"type": "string",
"nullable": true
},
"authorizedUserName": {
"type": "string",
"nullable": true
},
"revisedUserNo": {
"type": "string",
"nullable": true
},
"revisedUserName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystemDocument.ManagementSystemDocumentUnit": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"draft": {
"type": "boolean",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSection": {
"type": "object",
"properties": {
"sectionNo": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"documentTemplateName": {
"type": "string",
"nullable": true
},
"documentTemplateNo": {
"type": "string",
"nullable": true
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"managementSystemTitle": {
"type": "string",
"nullable": true
},
"mainIndex": {
"type": "boolean",
"nullable": true
},
"prefix": {
"type": "string",
"nullable": true
},
"documentNoFormat": {
"type": "string",
"nullable": true
},
"sortKey": {
"type": "integer",
"format": "int32",
"nullable": true
},
"parentSectionNo": {
"type": "string",
"nullable": true
},
"parentSectionName": {
"type": "string",
"nullable": true
},
"parentSectionId": {
"type": "string",
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSectionUnit.ManagementSystemSectionUnit"
},
"nullable": true
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSectionApprover"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystemSection.ManagementSystemSectionApprover": {
"type": "object",
"properties": {
"sectionId": {
"type": "string",
"nullable": true
},
"approvalOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"approverNo": {
"type": "string",
"nullable": true
},
"approverName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystemSectionUnit.ManagementSystemSectionUnit": {
"type": "object",
"properties": {
"sectionGuid": {
"type": "string",
"format": "uuid"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"revisionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"firstPublishDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"revisionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"replaceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"authorizingUserNo": {
"type": "string",
"nullable": true
},
"authorizingUserName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystems.ApiPublishResult": {
"type": "object",
"properties": {
"publishMode": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.PublishMode"
},
"success": {
"type": "boolean",
"readOnly": true
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.PublishIssue"
},
"nullable": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.PublishIssue"
},
"nullable": true
},
"skipRevisionDate": {
"type": "boolean"
},
"publishTask": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ManagementSystems.ManagementSystemPublishTask"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystems.ChangeRequestCriticality": {
"type": "object",
"properties": {
"criticalityNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystems.ChangeRequestSource": {
"type": "object",
"properties": {
"sourceNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequest": {
"type": "object",
"properties": {
"changeRequestNo": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ChangeRequestStatus"
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ChangeRequestType"
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"managementSystemTitle": {
"type": "string",
"nullable": true
},
"managementSystemDocumentNo": {
"type": "string",
"nullable": true
},
"managementSystemDocumentName": {
"type": "string",
"nullable": true
},
"managementSystemDocumentId": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentName": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"requestedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"requestedByUserNo": {
"type": "string",
"nullable": true
},
"requestedByUserName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"area": {
"type": "string",
"nullable": true
},
"commonDocument": {
"type": "boolean",
"nullable": true
},
"managementSystemDocumentRevisionNo": {
"type": "integer",
"format": "int32"
},
"minorChange": {
"type": "boolean",
"nullable": true
},
"minorChangeApproverGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"releaseInformation": {
"type": "string",
"nullable": true
},
"sourceNo": {
"type": "string",
"nullable": true
},
"sourceName": {
"type": "string",
"nullable": true
},
"criticalityNo": {
"type": "string",
"nullable": true
},
"criticalityName": {
"type": "string",
"nullable": true
},
"managementSystemIsLocked": {
"type": "boolean",
"nullable": true
},
"hasApprover": {
"type": "boolean",
"nullable": true
},
"affectedUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.Unit"
},
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestUnit"
},
"nullable": true
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ChangeRequestApprover"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystems.ManagementSystemChangeRequestResponse": {
"type": "object",
"properties": {
"changeRequestNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ManagementSystems.ManagementSystemPublishTask": {
"type": "object",
"properties": {
"tsTaskTaskNo": {
"type": "string",
"nullable": true
},
"tsTaskNextRunTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"managementSystemGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"managementSystemNo": {
"type": "string",
"nullable": true
},
"managementSystemTitle": {
"type": "string",
"nullable": true
},
"taskNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"progressText": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ManagementSystemPublishTaskStatus"
},
"publishArguments": {
"nullable": true
},
"taskType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.ManagementSystems.ManagementSystemPublishTaskTaskType"
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.ApiDuplicateJob": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"mdmJobNo": {
"type": "string",
"nullable": true
},
"mdmJobName": {
"type": "string",
"nullable": true
},
"unitJobNo": {
"type": "string",
"nullable": true
},
"unitJobName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.ApiDuplicateJobsAction": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"action": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.DuplicateJobsAction"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.ApiMDMCopyUnitArguments": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"sourceUnitNo": {
"type": "string",
"nullable": true
},
"targetUnitNo": {
"type": "string",
"nullable": true
},
"copyJobNo": {
"type": "boolean"
},
"copyJobName": {
"type": "boolean"
},
"copyExternalReference": {
"type": "boolean"
},
"copyJobRelations": {
"type": "boolean"
},
"copyClassRelated": {
"type": "boolean"
},
"copyDisabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.ApiSelectedPackageUnitInstance": {
"type": "object",
"properties": {
"packageUnitInstanceGuid": {
"type": "string",
"format": "uuid"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsArguments": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"selectedPackageUnitInstances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiSelectedPackageUnitInstance"
},
"nullable": true
},
"duplicateJobsActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiDuplicateJobsAction"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.ApiUpdateUnitsResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"readOnly": true
},
"validationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.UpdateUnitsIssue"
},
"nullable": true
},
"task": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MasterDataManagementTask"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.ApiUpdatedPackageUnitInstance": {
"type": "object",
"properties": {
"packageUnitInstanceGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"masterObjectComponentNo": {
"type": "string",
"nullable": true
},
"masterObjectComponentName": {
"type": "string",
"nullable": true
},
"unitComponentNo": {
"type": "string",
"nullable": true
},
"unitComponentName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"displayName": {
"type": "string",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.ApiUpdatedPackageUnitInstance"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.DuplicateJobsAction": {
"enum": [
"AddAsNew",
"LinkToExisting"
],
"type": "string"
},
"SerticaWebApi.Models.MasterDataManagementModels.MDMNodeType": {
"enum": [
"BaseComponent",
"Component",
"JobFolder",
"Job",
"RecurringJobFolder",
"RecurringJob",
"RunOnceJobFolder",
"RunOnceJob",
"ComponentItemFolder",
"ComponentItem",
"JobResourceFolder",
"JobResource",
"ComponentDocumentFolder",
"ComponentDocument2Link",
"JobDocumentFolder",
"JobDocument2Link",
"JobProcedureFolder",
"JobProcedure"
],
"type": "string"
},
"SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode": {
"type": "object",
"properties": {
"parentComponentGuid": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"hasChildren": {
"type": "boolean",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true
},
"visibleKey": {
"type": "string",
"nullable": true
},
"defaultComponentNo": {
"type": "string",
"nullable": true
},
"critical": {
"type": "boolean"
},
"disabled": {
"type": "boolean"
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMNodeType"
},
"hasComponents": {
"type": "boolean",
"nullable": true
},
"hasJobs": {
"type": "boolean",
"nullable": true
},
"hasItems": {
"type": "boolean",
"nullable": true
},
"hasDocuments": {
"type": "boolean",
"nullable": true
},
"hasProcedures": {
"type": "boolean",
"nullable": true
},
"hasResources": {
"type": "boolean",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMTreeStructureNode"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.MDMUnitNodeType": {
"enum": [
"UnitComponent",
"PackageDataComponent",
"PackageDataComponentOnUnit"
],
"type": "string"
},
"SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeArguments": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"tree": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeStructureNode"
},
"nullable": true
},
"deleteComponentNode": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeStructureNode"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeStructureNode": {
"type": "object",
"properties": {
"dirty": {
"type": "boolean"
},
"deleteUnitComponent": {
"type": "boolean",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"parentComponentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"masterObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"masterObjectNo": {
"type": "string",
"nullable": true
},
"masterObjectName": {
"type": "string",
"nullable": true
},
"masterObjectParentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"packageUnitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"packageUnitInstanceGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitRootComponentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"packageDataUnitRootComponentGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"packageDataUnitRootPackageUnitInstanceGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"masterDataClassGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"placedInRootOnUnit": {
"type": "boolean"
},
"overwriteExisting": {
"type": "boolean"
},
"hasChildren": {
"type": "boolean",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true
},
"visibleKey": {
"type": "string",
"nullable": true
},
"critical": {
"type": "boolean"
},
"disabled": {
"type": "boolean"
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitNodeType"
},
"hasComponents": {
"type": "boolean",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.MasterDataManagementModels.MDMUnitTreeStructureNode"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MasterDataManagementModels.MasterDataManagementTask": {
"type": "object",
"properties": {
"tsTaskTaskNo": {
"type": "string",
"nullable": true
},
"tsTaskRunTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"tsTaskNextRunTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"tsTaskActivated": {
"type": "boolean",
"nullable": true
},
"tsTaskDescription": {
"type": "string",
"nullable": true
},
"tsTaskTaskStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TaskStatus"
},
"name": {
"type": "string",
"nullable": true
},
"taskNo": {
"type": "string",
"nullable": true
},
"taskType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.MasterDataManagementTaskType"
},
"taskArguments": {
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.MasterDataManagementTaskStatus"
},
"progressText": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Measurement.Measurement": {
"type": "object",
"properties": {
"measurementNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"unitOfMeasurement": {
"type": "string",
"nullable": true
},
"tag": {
"type": "string",
"nullable": true
},
"latestReading": {
"type": "number",
"format": "double",
"nullable": true
},
"latestReadingDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"latestReadingPeriod": {
"type": "string",
"nullable": true
},
"latestReadingRemark": {
"type": "string",
"nullable": true
},
"measurementTypeFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+MeasurementTypeFormat"
},
"measurementTypeReadingPeriodMandatory": {
"type": "boolean",
"nullable": true
},
"typeNo": {
"type": "string",
"nullable": true
},
"typeName": {
"type": "string",
"nullable": true
},
"locationNo": {
"type": "string",
"nullable": true
},
"locationName": {
"type": "string",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"forceMeasureNoAsKeyWhenUsedInForms": {
"type": "boolean",
"nullable": true
},
"readings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Measurement.MeasurementHistory"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Measurement.MeasurementHistory": {
"type": "object",
"properties": {
"idSeq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"value": {
"type": "number",
"format": "double",
"nullable": true
},
"valueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"readingPeriod": {
"type": "string",
"nullable": true
},
"measurementNo": {
"type": "string",
"nullable": true
},
"measurementName": {
"type": "string",
"nullable": true
},
"unitOfMeasurement": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Measurement.MeasurementLocation": {
"type": "object",
"properties": {
"measurementLocationNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Measurement.MeasurementType": {
"type": "object",
"properties": {
"measurementTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.MeasuringUnit.MeasuringUnit": {
"type": "object",
"properties": {
"measuringUnitNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"shipdexDefault": {
"type": "boolean",
"nullable": true
},
"shipdexMeasureUnit": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipdexMeasureUnit"
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PaymentCondition.PaymentCondition": {
"type": "object",
"properties": {
"paymentConditionNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"communicationLanguageNo": {
"type": "string",
"nullable": true
},
"communicationLanguageName": {
"type": "string",
"nullable": true
},
"days": {
"type": "integer",
"format": "int32",
"nullable": true
},
"offset": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PaymentConditionOffset"
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Port": {
"type": "object",
"properties": {
"portCodeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"density": {
"type": "number",
"format": "double",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"keyPort": {
"type": "boolean",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PostingPeriod.PostingPeriod": {
"type": "object",
"properties": {
"postingPeriodNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodCompany"
},
"nullable": true
},
"periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PostingPeriod.PostingPeriodPeriod"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PostingPeriod.PostingPeriodCompany": {
"type": "object",
"properties": {
"postingPeriodNo": {
"type": "string",
"nullable": true
},
"postingPeriodName": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PostingPeriod.PostingPeriodPeriod": {
"type": "object",
"properties": {
"postingPeriodNo": {
"type": "string",
"nullable": true
},
"postingPeriodName": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"allowFirstDatePostingsFromDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Priority.Priority": {
"type": "object",
"properties": {
"priorityNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Procedure.Procedure": {
"type": "object",
"properties": {
"procedureNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Procedure.ProcedureDocument"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Procedure.ProcedureDocument": {
"type": "object",
"properties": {
"procedureNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.AddressClassification": {
"type": "object",
"properties": {
"classificationNo": {
"type": "string",
"nullable": true
},
"classificationName": {
"type": "string",
"nullable": true
},
"action": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AddressClassificationAction"
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationAnswer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"evaluationAnswerNo": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionImInvoiceLink": {
"type": "object",
"properties": {
"addressName": {
"type": "string",
"nullable": true
},
"addressNo": {
"type": "string",
"nullable": true
},
"objectNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationAnswerName": {
"type": "string",
"nullable": true
},
"evaluationAnswerNo": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"groupId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"evaluationStep": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+EvaluationProcess"
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"objectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink": {
"type": "object",
"properties": {
"addressName": {
"type": "string",
"nullable": true
},
"addressNo": {
"type": "string",
"nullable": true
},
"objectNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationAnswerName": {
"type": "string",
"nullable": true
},
"evaluationAnswerNo": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"groupId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"evaluationStep": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+EvaluationProcess"
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"objectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink": {
"type": "object",
"properties": {
"addressName": {
"type": "string",
"nullable": true
},
"addressNo": {
"type": "string",
"nullable": true
},
"objectNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationAnswerName": {
"type": "string",
"nullable": true
},
"evaluationAnswerNo": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"groupId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"evaluationStep": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+EvaluationProcess"
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"objectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink": {
"type": "object",
"properties": {
"addressName": {
"type": "string",
"nullable": true
},
"addressNo": {
"type": "string",
"nullable": true
},
"objectNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationAnswerName": {
"type": "string",
"nullable": true
},
"evaluationAnswerNo": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"groupId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"evaluationStep": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+EvaluationProcess"
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"objectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionShipmentLink": {
"type": "object",
"properties": {
"addressName": {
"type": "string",
"nullable": true
},
"addressNo": {
"type": "string",
"nullable": true
},
"objectNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationAnswerName": {
"type": "string",
"nullable": true
},
"evaluationAnswerNo": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"groupId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"evaluationStep": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+EvaluationProcess"
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"objectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationQuestion": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationStep": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+EvaluationProcess"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"localUnit": {
"type": "boolean",
"nullable": true
},
"normalUnit": {
"type": "boolean",
"nullable": true
},
"serviceOrder": {
"type": "boolean",
"nullable": true
},
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionCompany"
},
"nullable": true
},
"addressCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionAddressCategory"
},
"nullable": true
},
"itemTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionItemType"
},
"nullable": true
},
"evaluationAnswers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationQuestionEvaluationAnswer"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationQuestionAddressCategory": {
"type": "object",
"properties": {
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"addressCategoryNo": {
"type": "string",
"nullable": true
},
"addressCategoryName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationQuestionCompany": {
"type": "object",
"properties": {
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationQuestionEvaluationAnswer": {
"type": "object",
"properties": {
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"evaluationAnswerNo": {
"type": "string",
"nullable": true
},
"evaluationAnswerName": {
"type": "string",
"nullable": true
},
"commentRequired": {
"type": "boolean",
"nullable": true
},
"score": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isDefault": {
"type": "boolean"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.EvaluationQuestionItemType": {
"type": "object",
"properties": {
"evaluationQuestionNo": {
"type": "string",
"nullable": true
},
"evaluationQuestionName": {
"type": "string",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"itemTypeName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ProcurementQA.SuggestedActionSupplier": {
"type": "object",
"properties": {
"addressNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"addressClassificationNo": {
"type": "string",
"nullable": true
},
"addressClassificationName": {
"type": "string",
"nullable": true
},
"addressClassificationAction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AddressClassificationAction"
},
"evaluationScore": {
"type": "integer",
"format": "int32",
"nullable": true
},
"suggestedAction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AddressClassificationAction"
},
"suggestedAddressClassificationNo": {
"type": "string",
"nullable": true
},
"suggestedAddressClassificationName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Project.Project": {
"type": "object",
"properties": {
"projectNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.ProjectUnit"
},
"nullable": true
},
"stakeholders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Project.ProjectStakeholder"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Project.ProjectStakeholder": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"projectNo": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Project.ProjectUnit": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"projectNo": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseGroup.PurchaseGroup": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"purchaseGroupNo": {
"type": "string",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.ApiCombinePurchaseOrderResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionCreatePurchaseOrderIssue"
},
"nullable": true
},
"positionIssues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.CombinePurchaseOrderPositionIssue"
},
"nullable": true
},
"createdPurchaseOrder": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderCombineArguments": {
"type": "object",
"properties": {
"supplierNo": {
"type": "string",
"nullable": true
},
"addToExistingPONo": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"deliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"urgent": {
"type": "boolean",
"nullable": true
},
"includeDocumentsFromRequisitions": {
"type": "boolean",
"nullable": true
},
"positionArguments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiCombinePositionArguments"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.ApiPurchaseOrderPriceApproverResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PurchaseOrderPriceApproverIssue"
},
"nullable": true
},
"notification": {
"type": "string",
"nullable": true
},
"brokenRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BrokenRule"
},
"nullable": true
},
"updatedPurchaseOrder": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
},
"mail": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.ApiRequestForQuoteCreatePurchaseOrderResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteCreatePurchaseOrderIssue"
},
"nullable": true
},
"createdPurchaseOrder": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.ApiRequisitionCreatePurchaseOrderResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequisitionCreatePurchaseOrderIssue"
},
"nullable": true
},
"createdPurchaseOrder": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrder"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrder": {
"type": "object",
"properties": {
"prepaid": {
"type": "boolean",
"nullable": true
},
"urgent": {
"type": "boolean",
"nullable": true
},
"invoiceExpected": {
"type": "boolean",
"nullable": true
},
"deliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eta": {
"type": "string",
"format": "date-time",
"nullable": true
},
"etd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"freightForwarderReceptionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"latestFreightForwardReceptionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"orderDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"purchaseOrderCreateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"totalCost": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"totalCostsInStandardCurrency": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"discountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceTotalCostsInCurrency": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"invoiceTotalCostsInStandardCurrency": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"invoicedAmount": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"invoicedAmountInStandardCurrency": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"invoiceDifference": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"invoiceDifferenceInStandardCurrency": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"invoiceDeviationInPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+InvoiceStatus"
},
"orderStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderStatus"
},
"requisitionType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionTypeEnum"
},
"transitReceivedStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TransitReceivedStatus"
},
"orderWorkflow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderWorkflow"
},
"accountName": {
"type": "string",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"agentNo": {
"type": "string",
"nullable": true
},
"agentName": {
"type": "string",
"nullable": true
},
"areaSFINo": {
"type": "string",
"nullable": true
},
"classNo": {
"type": "string",
"nullable": true
},
"className": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"deliveryConditionNo": {
"type": "string",
"nullable": true
},
"deliveryConditionName": {
"type": "string",
"nullable": true
},
"deliveryPlaceName": {
"type": "string",
"nullable": true
},
"deliveryPlaceNo": {
"type": "string",
"nullable": true
},
"deliveryPlacePortName": {
"type": "string",
"nullable": true
},
"deliveryPlacePortNo": {
"type": "string",
"nullable": true
},
"deliveryPortName": {
"type": "string",
"nullable": true
},
"deliveryPortNo": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"divisionName": {
"type": "string",
"nullable": true
},
"divisionNo": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"externalReference2": {
"type": "string",
"nullable": true
},
"externalReference3": {
"type": "string",
"nullable": true
},
"externalReference4": {
"type": "string",
"nullable": true
},
"icName": {
"type": "string",
"nullable": true
},
"icNo": {
"type": "string",
"nullable": true
},
"incidentNo": {
"type": "string",
"nullable": true
},
"internalUnitReference": {
"type": "string",
"nullable": true
},
"communicationLanguageNo": {
"type": "string",
"nullable": true
},
"communicationLanguageName": {
"type": "string",
"nullable": true
},
"marketProductName": {
"type": "string",
"nullable": true
},
"marketProductNo": {
"type": "string",
"nullable": true
},
"navisionCompanyNo": {
"type": "string",
"nullable": true
},
"paymentConditionNo": {
"type": "string",
"nullable": true
},
"paymentConditionName": {
"type": "string",
"nullable": true
},
"projectCodeName": {
"type": "string",
"nullable": true
},
"projectCodeNo": {
"type": "string",
"nullable": true
},
"projectNo": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"purchaseOrderCreateUserNo": {
"type": "string",
"nullable": true
},
"purchaseOrderGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaserUserName": {
"type": "string",
"nullable": true
},
"purchaserUserNo": {
"type": "string",
"nullable": true
},
"purposeNo": {
"type": "string",
"nullable": true
},
"remarkToSupplier": {
"type": "string",
"nullable": true
},
"remarkToOffice": {
"type": "string",
"nullable": true
},
"orderConfirmationRemark": {
"type": "string",
"nullable": true
},
"supplierQuoteReference": {
"type": "string",
"nullable": true
},
"routeName": {
"type": "string",
"nullable": true
},
"routeNo": {
"type": "string",
"nullable": true
},
"sundryName": {
"type": "string",
"nullable": true
},
"sundryNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierAAGReference": {
"type": "string",
"nullable": true
},
"vendorNo": {
"type": "string",
"nullable": true
},
"vismaAgentName": {
"type": "string",
"nullable": true
},
"vismaAgentNo": {
"type": "string",
"nullable": true
},
"workflowCompanyNo": {
"type": "string",
"nullable": true
},
"supplierAttention": {
"type": "string",
"nullable": true
},
"deliveryPlaceAttention": {
"type": "string",
"nullable": true
},
"paidCash": {
"type": "boolean",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"itemTypeName": {
"type": "string",
"nullable": true
},
"deliveryDateToBeAdvised": {
"type": "boolean",
"nullable": true
},
"deliveryPlaceToBeAdvised": {
"type": "boolean",
"nullable": true
},
"supplierPhone": {
"type": "string",
"nullable": true
},
"supplierVatNo": {
"type": "string",
"nullable": true
},
"showPrice": {
"type": "boolean",
"nullable": true
},
"sendReminder": {
"type": "boolean",
"nullable": true
},
"orderConfirmationNo": {
"type": "string",
"nullable": true
},
"purchaseOrderConfirmStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderConfirmStatus"
},
"confirmedVia": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PurchaseOrderConfirmedVia"
},
"orderConfirmationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"orderedVia": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SupplierPurchaseOrderForwardType"
},
"sentTo": {
"type": "string",
"nullable": true
},
"sentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"viewDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"showInWeb": {
"type": "boolean",
"nullable": true
},
"supplierDocuments": {
"type": "boolean",
"nullable": true
},
"nextApproverNo": {
"type": "string",
"nullable": true
},
"nextApproverName": {
"type": "string",
"nullable": true
},
"approvalSetupNo": {
"type": "string",
"nullable": true
},
"approvalSetupName": {
"type": "string",
"nullable": true
},
"orderedByUserNo": {
"type": "string",
"nullable": true
},
"orderedByUserName": {
"type": "string",
"nullable": true
},
"forwardDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"originalDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32",
"nullable": true
},
"copiedFromGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"shared": {
"type": "boolean",
"nullable": true
},
"sharedUnitPO": {
"type": "boolean",
"nullable": true
},
"deliveryDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"totalCO2": {
"type": "number",
"format": "double",
"nullable": true
},
"customProperties": {
"nullable": true
},
"positionsSubTotal": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"deliveryCostsSubTotal": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"accountingDimensions": {
"nullable": true
},
"usedDimensions": {
"nullable": true
},
"addressClassificationAction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AddressClassificationAction"
},
"punchOut": {
"type": "boolean",
"nullable": true
},
"addressPunchOutName": {
"type": "string",
"nullable": true
},
"punchOutStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PunchOutStatus"
},
"portLocode": {
"type": "string",
"nullable": true
},
"createdFromRequisitionNo": {
"type": "string",
"nullable": true
},
"sourceRfqForNewOrderGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rejectCoherentRfqsWhenSaving": {
"type": "boolean",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDocument"
},
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse"
},
"nullable": true
},
"deliveryCosts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost"
},
"nullable": true
},
"requestForQuotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePurchaseOrder"
},
"nullable": true
},
"requisitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderRequisition"
},
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderUnit"
},
"nullable": true
},
"sharedUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderSharedUnit"
},
"nullable": true
},
"approvals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderApproval"
},
"nullable": true
},
"evaluations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionPurchaseOrderLink"
},
"nullable": true
},
"standardTexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderStandardText"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderApproval": {
"type": "object",
"properties": {
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderGuid": {
"type": "string",
"format": "uuid"
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyDecimalPlaces": {
"type": "integer",
"format": "int32"
},
"amount": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"level": {
"type": "integer",
"format": "int32",
"nullable": true
},
"current": {
"type": "boolean",
"nullable": true
},
"purchaseOrderChecksum": {
"type": "integer",
"format": "int32",
"nullable": true
},
"singleApprovalValidation": {
"type": "boolean",
"nullable": true
},
"userNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderCalculatedFields": {
"type": "object",
"properties": {
"accountInformation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/System.Collections.Generic.KeyValuePair`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDeliveryCost": {
"type": "object",
"properties": {
"deliveryCostNo": {
"type": "string",
"nullable": true
},
"deliveryCostName": {
"type": "string",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderName": {
"type": "string",
"nullable": true
},
"cost": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"sfiNo": {
"type": "string",
"nullable": true
},
"sfiName": {
"type": "string",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"classNo": {
"type": "string",
"nullable": true
},
"className": {
"type": "string",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"accountingDimensions": {
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderDocument": {
"type": "object",
"properties": {
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"sendToSupplier": {
"type": "boolean",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPlaceArguments": {
"type": "object",
"properties": {
"acceptRequestQuantityIsDifferentThanSupplierQuantity": {
"type": "boolean"
},
"updateSupplierPrices": {
"type": "boolean"
},
"resendPurchaseOrder": {
"type": "boolean",
"nullable": true
},
"forwardType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SupplierPurchaseOrderForwardType"
},
"mail": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPosition": {
"type": "object",
"properties": {
"bunker": {
"type": "boolean"
},
"deliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"latestReceivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"discountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"unitPrice": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"orderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"receivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"rejectedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"requestedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"drawingNo": {
"type": "string",
"nullable": true
},
"drawingPosNo": {
"type": "string",
"nullable": true
},
"equipmentName": {
"type": "string",
"nullable": true
},
"equipmentRating": {
"type": "string",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"manufacture": {
"type": "string",
"nullable": true
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"measureUnitName": {
"type": "string",
"nullable": true
},
"model": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"positionClassNo": {
"type": "string",
"nullable": true
},
"positionClassName": {
"type": "string",
"nullable": true
},
"purchaseOrderGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"referenceNo": {
"type": "string",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"supplierRemark": {
"type": "string",
"nullable": true
},
"sfiNo": {
"type": "string",
"nullable": true
},
"sfiName": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemUnitNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"standardNo": {
"type": "string",
"nullable": true
},
"supplierItemNo": {
"type": "string",
"nullable": true
},
"supplierItemDescription": {
"type": "string",
"nullable": true
},
"typeNo": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"internalRemark": {
"type": "string",
"nullable": true
},
"rejectRemark": {
"type": "string",
"nullable": true
},
"listNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"totalPrice": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"allowThirdPartyItem": {
"type": "boolean",
"nullable": true
},
"outstandingQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"supplierItemDeliveryDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"maxStock": {
"type": "number",
"format": "double",
"nullable": true
},
"minStock": {
"type": "number",
"format": "double",
"nullable": true
},
"stock": {
"type": "number",
"format": "double",
"nullable": true
},
"ordered": {
"type": "number",
"format": "double",
"nullable": true
},
"requested": {
"type": "number",
"format": "double",
"nullable": true
},
"dimension": {
"type": "string",
"nullable": true
},
"referencePosNo": {
"type": "string",
"nullable": true
},
"classification": {
"type": "string",
"nullable": true
},
"daysUntilDelivery": {
"type": "integer",
"format": "int32",
"nullable": true
},
"receivedByUserNo": {
"type": "string",
"nullable": true
},
"receivedByUserName": {
"type": "string",
"nullable": true
},
"deliveryNoteNo": {
"type": "string",
"nullable": true
},
"hsCodeNo": {
"type": "string",
"nullable": true
},
"hsWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"cO2": {
"type": "number",
"format": "double",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"transitReceivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"accountingDimensions": {
"nullable": true
},
"supplierPartAuxiliaryID": {
"type": "string",
"nullable": true
},
"purchaseOrderPositionRequisitionPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPositionRequisitionPosition"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPositionCalculatedFields": {
"type": "object",
"properties": {
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"totalPrice": {
"type": "number",
"format": "double"
},
"totalPriceInStandardCurrency": {
"type": "number",
"format": "double",
"nullable": true
},
"accountInformation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/System.Collections.Generic.KeyValuePair`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPositionRequisitionPosition": {
"type": "object",
"properties": {
"ownerUnitNo": {
"type": "string",
"nullable": true
},
"ownerUnitName": {
"type": "string",
"nullable": true
},
"purchaseOrderPositionGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"procurementRequisitionPositionGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"procurementRequisitionForSharedUnitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"requestedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"rejectedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"receivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"receivedByUserNo": {
"type": "string",
"nullable": true
},
"receivedByUserName": {
"type": "string",
"nullable": true
},
"rejectRemark": {
"type": "string",
"nullable": true
},
"requisitionNo": {
"type": "string",
"nullable": true
},
"requisitionPositionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"orderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"unitPrice": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"discountPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"totalPrice": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"currencyNo": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"itemUnitNo": {
"type": "string",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"measureUnitName": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPriceApprovalArguments": {
"type": "object",
"properties": {
"acceptRequestQuantityIsDifferentThanSupplierQuantity": {
"type": "boolean",
"nullable": true
},
"selectedApproverNo": {
"type": "string",
"nullable": true
},
"mail": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
},
"approvalConfirmed": {
"type": "boolean",
"nullable": true
},
"unacknowledgedResponseLogsConfirmed": {
"type": "boolean",
"nullable": true
},
"approvalSetupNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderRequisition": {
"type": "object",
"properties": {
"requisitionNo": {
"type": "string",
"nullable": true
},
"requisitionDescription": {
"type": "string",
"nullable": true
},
"requisitionUnitNo": {
"type": "string",
"nullable": true
},
"requisitionUnitName": {
"type": "string",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderDescription": {
"type": "string",
"nullable": true
},
"purchaseOrderOwnerUnitNo": {
"type": "string",
"nullable": true
},
"purchaseOrderOwnerUnitName": {
"type": "string",
"nullable": true
},
"referencedUnitNo": {
"type": "string",
"nullable": true
},
"referencedUnitName": {
"type": "string",
"nullable": true
},
"requestedDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderResponse": {
"type": "object",
"properties": {
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"purchaseOrderGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderSharedUnit": {
"type": "object",
"properties": {
"purchaseOrderGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderDescription": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderStandardText": {
"type": "object",
"properties": {
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderDescription": {
"type": "string",
"nullable": true
},
"standardTextNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseOrder.PurchaseOrderUnit": {
"type": "object",
"properties": {
"purchaseOrderGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderDescription": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"requisitionNo": {
"type": "string",
"nullable": true
},
"requisitionDescription": {
"type": "string",
"nullable": true
},
"exchangeRateUnit": {
"type": "number",
"format": "double",
"nullable": true
},
"createdFromSharedPO": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseType.PurchaseType": {
"type": "object",
"properties": {
"purchaseTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"projectNoMandatory": {
"type": "boolean",
"nullable": true
},
"projectOptional": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.PurchaseTypeView+MandatoryOptionalEnum"
},
"unitAvailability": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ClassAvailable"
},
"unitFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseTypeUnitFilter"
},
"nullable": true
},
"companyUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseType.PurchaseTypeCompanyUnit"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseType.PurchaseTypeCompanyUnit": {
"type": "object",
"properties": {
"purchaseTypeNo": {
"type": "string",
"nullable": true
},
"purchaseTypeName": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.PurchaseType.PurchaseTypeUnitFilter": {
"type": "object",
"properties": {
"purchaseTypeNo": {
"type": "string",
"nullable": true
},
"purchaseTypeName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RejectReason.RejectReason": {
"type": "object",
"properties": {
"reasonNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"restrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RejectReason.RejectReasonRestriction"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RejectReason.RejectReasonRestriction": {
"type": "object",
"properties": {
"reasonType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ReasonType"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Reminder.Reminder": {
"type": "object",
"properties": {
"objectNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"objectType": {
"type": "string",
"nullable": true
},
"reminderDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reminderType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AutomaticReminderType"
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"mailGuid": {
"type": "string",
"nullable": true
},
"sentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"objectDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"mailStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+EmailStatus"
},
"unitNo": {
"type": "string",
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.ReminderPosition"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Reminder.ReminderEmailAttachment": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"nullable": true
},
"fileFound": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Reminder.ReminderEmailDetails": {
"type": "object",
"properties": {
"from": {
"type": "string",
"nullable": true
},
"to": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"sentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"statusName": {
"type": "string",
"nullable": true
},
"mailAccountNo": {
"type": "string",
"nullable": true
},
"smtpHostName": {
"type": "string",
"nullable": true
},
"smtpUserAccount": {
"type": "string",
"nullable": true
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Reminder.ReminderEmailAttachment"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Reminder.ReminderPosition": {
"type": "object",
"properties": {
"procurementQARemindersGuid": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"orderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"receivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineArguments": {
"type": "object",
"properties": {
"adviseBy": {
"type": "string",
"format": "date-time",
"nullable": true
},
"supplierArguments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineSupplierArguments"
},
"nullable": true
},
"addToExistingRFQNo": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"deliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"urgent": {
"type": "boolean",
"nullable": true
},
"includeDocumentsFromRequisitions": {
"type": "boolean",
"nullable": true
},
"positionArguments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiCombinePositionArguments"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteCombineSupplierArguments": {
"type": "object",
"properties": {
"supplierNo": {
"type": "string",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"deliveryPlaceNo": {
"type": "string",
"nullable": true
},
"deliveryPlaceToBeAdvised": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.ApiRequestForQuoteStatusChangeResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.RequestForQuoteStatusChangeResultIssue"
},
"nullable": true
},
"updatedRequestForQuote": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuote"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.RequestForQuote": {
"type": "object",
"properties": {
"coherentRfqGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requestForQuoteNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequestForQuoteStatus"
},
"workflow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequestForQuoteWorkflow"
},
"requestedDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"daysUntilDelivery": {
"type": "integer",
"format": "int32",
"nullable": true
},
"adviceBy": {
"type": "string",
"format": "date-time",
"nullable": true
},
"deliveryPlaceToBeAdvised": {
"type": "boolean",
"nullable": true
},
"urgent": {
"type": "boolean",
"nullable": true
},
"acknowledged": {
"type": "boolean",
"nullable": true
},
"sendReminder": {
"type": "boolean",
"nullable": true
},
"shared": {
"type": "boolean",
"nullable": true
},
"sharedUnitRFQ": {
"type": "boolean",
"nullable": true
},
"sentVia": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SupplierForwardType"
},
"showInConnect": {
"type": "boolean",
"nullable": true
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"exchangeRate": {
"type": "number",
"format": "double",
"nullable": true
},
"totalPrice": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"totalPriceInStandardCurrency": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"expectedPOPrice": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"expectedPOPriceInStandardCurrency": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"deliveryPlaceNo": {
"type": "string",
"nullable": true
},
"deliveryPlaceName": {
"type": "string",
"nullable": true
},
"agentNo": {
"type": "string",
"nullable": true
},
"agentName": {
"type": "string",
"nullable": true
},
"communicationLanguageNo": {
"type": "string",
"nullable": true
},
"communicationLanguageName": {
"type": "string",
"nullable": true
},
"paymentConditionNo": {
"type": "string",
"nullable": true
},
"paymentConditionName": {
"type": "string",
"nullable": true
},
"deliveryConditionNo": {
"type": "string",
"nullable": true
},
"deliveryConditionName": {
"type": "string",
"nullable": true
},
"remarkToSupplier": {
"type": "string",
"nullable": true
},
"remarkFromSupplier": {
"type": "string",
"nullable": true
},
"supplierAttention": {
"type": "string",
"nullable": true
},
"supplierQuoteReference": {
"type": "string",
"nullable": true
},
"discount": {
"type": "number",
"format": "double",
"nullable": true
},
"validUntil": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateSent": {
"type": "string",
"format": "date-time",
"nullable": true
},
"receivedVia": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequestForQuoteReceivedVia"
},
"importDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"viewDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"purchaserUserNo": {
"type": "string",
"nullable": true
},
"purchaserUserName": {
"type": "string",
"nullable": true
},
"externalReference": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"receivedNotReceivedCoherentString": {
"type": "string",
"nullable": true
},
"allQuotesReceived": {
"type": "boolean",
"nullable": true
},
"sentTo": {
"type": "string",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"itemTypeName": {
"type": "string",
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse"
},
"nullable": true
},
"standardTexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteStandardText"
},
"nullable": true
},
"deliveryCosts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteDeliveryCost"
},
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePosition"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuoteDocument"
},
"nullable": true
},
"purchaseOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.RequestForQuote.RequestForQuotePurchaseOrder"
},
"nullable": true
},
"evaluations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequestForQuoteLink"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.RequestForQuoteDeliveryCost": {
"type": "object",
"properties": {
"deliveryCostNo": {
"type": "string",
"nullable": true
},
"deliveryCostName": {
"type": "string",
"nullable": true
},
"requestForQuoteNo": {
"type": "string",
"nullable": true
},
"requestForQuoteName": {
"type": "string",
"nullable": true
},
"cost": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.RequestForQuoteDocument": {
"type": "object",
"properties": {
"requestForQuoteNo": {
"type": "string",
"nullable": true
},
"sendToSupplier": {
"type": "boolean",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.RequestForQuotePosition": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"requestForQuoteNo": {
"type": "string",
"nullable": true
},
"requestForQuoteDescription": {
"type": "string",
"nullable": true
},
"listNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"itemGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"transferToPurchaseOrder": {
"type": "boolean",
"nullable": true
},
"requestedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"quotedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"quantityToOrder": {
"type": "number",
"format": "double",
"nullable": true
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"measureUnitName": {
"type": "string",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"discount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalPrice": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"allowThirdPartyItem": {
"type": "boolean",
"nullable": true
},
"supplierItemNo": {
"type": "string",
"nullable": true
},
"supplierItemDescription": {
"type": "string",
"nullable": true
},
"workflow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequestForQuoteWorkflow"
},
"remark": {
"type": "string",
"nullable": true
},
"internalRemark": {
"type": "string",
"nullable": true
},
"deliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"daysUntilDelivery": {
"type": "integer",
"format": "int32",
"nullable": true
},
"manufacture": {
"type": "string",
"nullable": true
},
"referenceNo": {
"type": "string",
"nullable": true
},
"drawingNo": {
"type": "string",
"nullable": true
},
"drawingPosNo": {
"type": "string",
"nullable": true
},
"referencePosNo": {
"type": "string",
"nullable": true
},
"dimensions": {
"type": "string",
"nullable": true
},
"typeNo": {
"type": "string",
"nullable": true
},
"classification": {
"type": "string",
"nullable": true
},
"equipmentName": {
"type": "string",
"nullable": true
},
"equipmentRating": {
"type": "string",
"nullable": true
},
"standardNo": {
"type": "string",
"nullable": true
},
"suppliersDescription": {
"type": "string",
"nullable": true
},
"hsCodeNo": {
"type": "string",
"nullable": true
},
"hsWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"itemUnitNo": {
"type": "string",
"nullable": true
},
"priceTrendIndicator": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.PriceTrendIndicator"
},
"totalQuantityFromRequisitions": {
"type": "number",
"format": "double",
"nullable": true
},
"measuringUnitNoFromRequisition": {
"type": "string",
"nullable": true
},
"supplierRemark": {
"type": "string",
"nullable": true
},
"itemReferenceNo": {
"type": "string",
"nullable": true
},
"cO2": {
"type": "number",
"format": "double",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.RequestForQuotePurchaseOrder": {
"type": "object",
"properties": {
"requestForQuoteNo": {
"type": "string",
"nullable": true
},
"requestForQuoteDescription": {
"type": "string",
"nullable": true
},
"requestForQuoteUnitNo": {
"type": "string",
"nullable": true
},
"requestForQuoteUnitName": {
"type": "string",
"nullable": true
},
"purchaseOrderNo": {
"type": "string",
"nullable": true
},
"purchaseOrderDescription": {
"type": "string",
"nullable": true
},
"purchaseOrderUnitOwnerNo": {
"type": "string",
"nullable": true
},
"purchaseOrderUnitOwnerName": {
"type": "string",
"nullable": true
},
"numberOfConnectedRFQs": {
"type": "string",
"nullable": true
},
"totalPrice": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"totalPriceInStandardCurrency": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.RequestForQuoteResponse": {
"type": "object",
"properties": {
"requestForQuoteNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.RequestForQuoteStandardText": {
"type": "object",
"properties": {
"requestForQuoteNo": {
"type": "string",
"nullable": true
},
"requestForQuoteDescription": {
"type": "string",
"nullable": true
},
"standardTextNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.RequestForQuoteStatusChangerArguments": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequestForQuoteStatus"
},
"statusChangeConfirmed": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.RequestForQuote.RfqSendToSupplierArguments": {
"type": "object",
"properties": {
"forwardType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SupplierForwardType"
},
"mail": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ApiMail"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.ApiRequisitionRejectHandler+ApiRequisitionRejectHandlerResult": {
"type": "object",
"properties": {
"rejectedRequisition": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.Requisition"
},
"success": {
"type": "boolean",
"readOnly": true
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Requisition.RequisitionRejectHandlerIssue"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.PositionOrderedOrRequested": {
"type": "object",
"properties": {
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"stock": {
"type": "number",
"format": "double"
},
"requested": {
"type": "number",
"format": "double"
},
"ordered": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.Requisition": {
"type": "object",
"properties": {
"requisitionNo": {
"type": "string",
"nullable": true
},
"requisitionType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionTypeEnum"
},
"description": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionStatus"
},
"workflow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionWorkflow"
},
"requestedDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"orderDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"urgent": {
"type": "boolean",
"nullable": true
},
"departmentNo": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"localCurrencyNo": {
"type": "string",
"nullable": true
},
"localCurrencyName": {
"type": "string",
"nullable": true
},
"exchangeRateUnit": {
"type": "number",
"format": "double",
"nullable": true
},
"projectNo": {
"type": "string",
"nullable": true
},
"projectName": {
"type": "string",
"nullable": true
},
"totalCostsInCurrency": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"estimatedCosts": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount"
},
"orderedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"orderedByUserNo": {
"type": "string",
"nullable": true
},
"orderedByUserName": {
"type": "string",
"nullable": true
},
"requestedByRoleNo": {
"type": "string",
"nullable": true
},
"requestedByRoleName": {
"type": "string",
"nullable": true
},
"requestedByUserNo": {
"type": "string",
"nullable": true
},
"requestedByUserName": {
"type": "string",
"nullable": true
},
"requestedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"technicalApprovalDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"technicalApprovedByUserNo": {
"type": "string",
"nullable": true
},
"technicalApprovedByUserName": {
"type": "string",
"nullable": true
},
"supplierNo": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"deliveryPlaceNo": {
"type": "string",
"nullable": true
},
"deliveryPlaceName": {
"type": "string",
"nullable": true
},
"vendorNo": {
"type": "string",
"nullable": true
},
"supplierCurrencyNo": {
"type": "string",
"nullable": true
},
"remarkToSupplier": {
"type": "string",
"nullable": true
},
"remarkToOffice": {
"type": "string",
"nullable": true
},
"purchaseTypeNo": {
"type": "string",
"nullable": true
},
"purchaseTypeName": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"componentNosAsString": {
"type": "string",
"nullable": true
},
"componentNamesAsString": {
"type": "string",
"nullable": true
},
"jobNosAsString": {
"type": "string",
"nullable": true
},
"jobNamesAsString": {
"type": "string",
"nullable": true
},
"hasPositions": {
"type": "boolean",
"nullable": true
},
"punchOut": {
"type": "boolean",
"nullable": true
},
"addressPunchOutName": {
"type": "string",
"nullable": true
},
"punchOutStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+PunchOutStatus"
},
"portLocode": {
"type": "string",
"nullable": true
},
"positionsReadyForOrderCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"copiedFromGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"itemTypeName": {
"type": "string",
"nullable": true
},
"accountingDimensions": {
"nullable": true
},
"usedDimensions": {
"nullable": true
},
"agentNo": {
"type": "string",
"nullable": true
},
"agentName": {
"type": "string",
"nullable": true
},
"discount": {
"type": "number",
"format": "double",
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionResponse"
},
"nullable": true
},
"standardTexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionStandardText"
},
"nullable": true
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionComponent"
},
"nullable": true
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionPosition"
},
"nullable": true
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionJob"
},
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Requisition.RequisitionDocument"
},
"nullable": true
},
"purchaseOrderPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.PurchaseOrder.PurchaseOrderPositionRequisitionPosition"
},
"nullable": true
},
"evaluations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ProcurementQA.EvaluationObjectLink.EvaluationQuestionRequisitionLink"
},
"nullable": true
},
"componentInfo": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionApproveForPurchaseArguments": {
"type": "object",
"properties": {
"positionNoApprovalList": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionApproveForRFQArguments": {
"type": "object",
"properties": {
"positionNoApprovalList": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionComponent": {
"type": "object",
"properties": {
"requisitionNo": {
"type": "string",
"nullable": true
},
"requisitionDescription": {
"type": "string",
"nullable": true
},
"componentNo": {
"type": "string",
"nullable": true
},
"componentName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionDocument": {
"type": "object",
"properties": {
"requisitionNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"sendToSupplier": {
"type": "boolean",
"nullable": true
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionForwardForHandlingArguments": {
"type": "object",
"properties": {
"acceptPositionSuppliers": {
"type": "boolean",
"nullable": true
},
"acceptItemsRequestedOrOrdered": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionForwardForTechnicalApprovalArguments": {
"type": "object",
"properties": {
"positionNoTechnicalApprovalList": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionJob": {
"type": "object",
"properties": {
"requisitionNo": {
"type": "string",
"nullable": true
},
"requisitionDescription": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionPosition": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"requisitionNo": {
"type": "string",
"nullable": true
},
"requisitionDescription": {
"type": "string",
"nullable": true
},
"positionNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"quantityToOrder": {
"type": "number",
"format": "double",
"nullable": true
},
"orderedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"receivedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"rejectedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"requestedQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"requestedMeasureUnitNo": {
"type": "string",
"nullable": true
},
"requestedMeasureUnitName": {
"type": "string",
"nullable": true
},
"measureUnitNo": {
"type": "string",
"nullable": true
},
"measureUnitName": {
"type": "string",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"currencyNo": {
"type": "string",
"nullable": true
},
"currencyName": {
"type": "string",
"nullable": true
},
"standardCurrencyNo": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"internalRemark": {
"type": "string",
"nullable": true
},
"rejectRemark": {
"type": "string",
"nullable": true
},
"rejected": {
"type": "boolean",
"nullable": true
},
"workflow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ProcurementRequisitionWorkflow"
},
"supplierItemNo": {
"type": "string",
"nullable": true
},
"supplierItemDescription": {
"type": "string",
"nullable": true
},
"standardNo": {
"type": "string",
"nullable": true
},
"maxStock": {
"type": "number",
"format": "double",
"nullable": true
},
"minStock": {
"type": "number",
"format": "double",
"nullable": true
},
"stock": {
"type": "number",
"format": "double",
"nullable": true
},
"ordered": {
"type": "number",
"format": "double",
"nullable": true
},
"requested": {
"type": "number",
"format": "double",
"nullable": true
},
"manufacture": {
"type": "string",
"nullable": true
},
"drawingNo": {
"type": "string",
"nullable": true
},
"dimensions": {
"type": "string",
"nullable": true
},
"drawingPosNo": {
"type": "string",
"nullable": true
},
"referencePosNo": {
"type": "string",
"nullable": true
},
"typeNo": {
"type": "string",
"nullable": true
},
"classification": {
"type": "string",
"nullable": true
},
"referenceNo": {
"type": "string",
"nullable": true
},
"equipmentName": {
"type": "string",
"nullable": true
},
"equipmentRating": {
"type": "string",
"nullable": true
},
"deliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"requestedDeliveryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"technicalApprovalDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"technicalApprovalUserNo": {
"type": "string",
"nullable": true
},
"technicalApprovalUserName": {
"type": "string",
"nullable": true
},
"hsCodeNo": {
"type": "string",
"nullable": true
},
"hsWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"technicalAccountNo": {
"type": "string",
"nullable": true
},
"technicalAccountName": {
"type": "string",
"nullable": true
},
"technicalAccountNoName": {
"type": "string",
"nullable": true
},
"jobNo": {
"type": "string",
"nullable": true
},
"jobName": {
"type": "string",
"nullable": true
},
"itemUnitNo": {
"type": "string",
"nullable": true
},
"itemGroupNos": {
"type": "string",
"nullable": true
},
"itemGroupNoNames": {
"type": "string",
"nullable": true
},
"itemTypeNo": {
"type": "string",
"nullable": true
},
"itemTypeName": {
"type": "string",
"nullable": true
},
"itemTypeNoName": {
"type": "string",
"nullable": true
},
"standardSupplierNo": {
"type": "string",
"nullable": true
},
"standardSupplierName": {
"type": "string",
"nullable": true
},
"standardSupplierNoName": {
"type": "string",
"nullable": true
},
"itemGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"urgent": {
"type": "boolean",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"itemReferenceNo": {
"type": "string",
"nullable": true
},
"cO2": {
"type": "number",
"format": "double",
"nullable": true
},
"supplierReferenceNo": {
"type": "string",
"nullable": true
},
"linkedToOpenRFQPosition": {
"type": "boolean"
},
"priceInStandardCurrency": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"totalPriceInStandardCurrency": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"deliveryNoteNo": {
"type": "string",
"nullable": true
},
"rejectReasonNo": {
"type": "string",
"nullable": true
},
"rejectReasonName": {
"type": "string",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"outstandingQuantity": {
"type": "number",
"format": "double",
"nullable": true
},
"accountingDimensions": {
"nullable": true
},
"discount": {
"type": "number",
"format": "double"
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionRejectArguments": {
"type": "object",
"properties": {
"positionNoRejectList": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionRequestUnitRespecificationArguments": {
"type": "object",
"properties": {
"responseText": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionResponse": {
"type": "object",
"properties": {
"requisitionNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionStandardText": {
"type": "object",
"properties": {
"requisitionNo": {
"type": "string",
"nullable": true
},
"requisitionDescription": {
"type": "string",
"nullable": true
},
"standardTextNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Requisition.RequisitionTasklistFilter": {
"type": "object",
"properties": {
"nodeType": {
"type": "string",
"nullable": true
},
"requisitionNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"unitList": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"columns": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Resource.Resource": {
"type": "object",
"properties": {
"resourceNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"rate": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"isUser": {
"type": "boolean"
},
"isUserGroup": {
"type": "boolean"
},
"windowsUserName": {
"type": "string",
"nullable": true
},
"availableAsResourceOnJob": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"availableAsResourceOnJobHistory": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"availableAsAssignee": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SavedGridLayout.JobListWebSearch": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"dynamicGridSetup": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.DynamicGridSetup"
},
"ownerUserNo": {
"type": "string",
"nullable": true
},
"ownerUserName": {
"type": "string",
"nullable": true
},
"availableInApp": {
"type": "boolean",
"nullable": true
},
"availableInJobList": {
"type": "boolean",
"nullable": true
},
"usersAsString": {
"type": "string",
"nullable": true
},
"userNamesAsString": {
"type": "string",
"nullable": true
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SavedGridLayout.JobListWebSearchUser": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"userTitle": {
"type": "string",
"nullable": true
},
"jobListWebSearchGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"jobListWebSearchName": {
"type": "string",
"nullable": true
},
"sharedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"availableInApp": {
"type": "boolean",
"nullable": true
},
"availableInJobList": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SavedGridLayout.SavedGridLayout": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"repositoryName": {
"type": "string",
"nullable": true
},
"dynamicGridSetup": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.DynamicGridSetup"
},
"ownerUserNo": {
"type": "string",
"nullable": true
},
"ownerUserName": {
"type": "string",
"nullable": true
},
"usersAsString": {
"type": "string",
"nullable": true
},
"userNamesAsString": {
"type": "string",
"nullable": true
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SavedGridLayout.SavedGridLayoutUser": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"userTitle": {
"type": "string",
"nullable": true
},
"savedGridLayoutGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"savedGridLayoutName": {
"type": "string",
"nullable": true
},
"sharedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Section.Section": {
"type": "object",
"properties": {
"sectionNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"sections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Section.SectionSection"
},
"nullable": true
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.User"
},
"nullable": true
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Component.Component"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Section.SectionSection": {
"type": "object",
"properties": {
"parentSectionNo": {
"type": "string",
"nullable": true
},
"parentSectionName": {
"type": "string",
"nullable": true
},
"subSectionNo": {
"type": "string",
"nullable": true
},
"subSectionName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Security.AccessRequest": {
"type": "object",
"properties": {
"roleNo": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Security.AuthenticationIntegration": {
"type": "object",
"properties": {
"azureAD": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.AzureAD.AzureADInformation"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Security.ChangePasswordInformation": {
"type": "object",
"properties": {
"password1": {
"type": "string",
"nullable": true
},
"password2": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Security.ForgotPasswordInformation": {
"type": "object",
"properties": {
"email": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Security.JwtToken": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"nullable": true
},
"expiresIn": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Security.ResetPasswordInformation": {
"type": "object",
"properties": {
"token": {
"type": "string",
"nullable": true
},
"password1": {
"type": "string",
"nullable": true
},
"password2": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Security.ResetPinInformation": {
"type": "object",
"properties": {
"pin": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Security.SerticaUser": {
"type": "object",
"properties": {
"login": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"roleNo": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"totpCode": {
"type": "string",
"nullable": true
},
"recoveryCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Security.TotpSetup": {
"type": "object",
"properties": {
"secret": {
"type": "string",
"nullable": true
},
"qrCodeImage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Security.UnitNodeType": {
"enum": [
"Unit",
"UnitGroup"
],
"type": "string"
},
"SerticaWebApi.Models.Security.UnitStructureNode": {
"type": "object",
"properties": {
"hasChildren": {
"type": "boolean",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true
},
"visibleKey": {
"type": "string",
"nullable": true
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.UnitNodeType"
},
"selectAtLogin": {
"type": "boolean"
},
"inactive": {
"type": "boolean"
},
"unitGuid": {
"type": "string",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Security.UnitStructureNode"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.StandardText": {
"type": "object",
"properties": {
"standardTextNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"texts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Localization.StandardTextLanguage"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Stock.AppStockMovement": {
"type": "object",
"properties": {
"itemGuid": {
"type": "string",
"nullable": true
},
"originWarehouseGuid": {
"type": "string",
"nullable": true
},
"originItemLocationGuid": {
"type": "string",
"nullable": true
},
"originUnitGuid": {
"type": "string",
"nullable": true
},
"destinationWarehouseGuid": {
"type": "string",
"nullable": true
},
"destinationUnitGuid": {
"type": "string",
"nullable": true
},
"destinationItemLocationGuid": {
"type": "string",
"nullable": true
},
"stockQuantity": {
"type": "number",
"format": "double"
},
"sourceSystem": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Stock.ItemLocation": {
"type": "object",
"properties": {
"itemLocationNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"parentLocationNo": {
"type": "string",
"nullable": true
},
"parentLocationName": {
"type": "string",
"nullable": true
},
"parentLocationGuid": {
"type": "string",
"format": "uuid"
},
"warehouseNo": {
"type": "string",
"nullable": true
},
"warehouseName": {
"type": "string",
"nullable": true
},
"warehouseGuid": {
"type": "string",
"format": "uuid"
},
"hasSubItemLocations": {
"type": "boolean"
},
"hasSubItems": {
"type": "boolean"
},
"warehouseNoNameStructure": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Stock.StockAdjustment": {
"type": "object",
"properties": {
"warehouseNo": {
"type": "string",
"nullable": true
},
"itemLocationNo": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Framework.Amount"
},
"description": {
"type": "string",
"nullable": true
},
"stockAdjustmentType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Stock.StockAdjustmentType"
},
"fromSerticaApp": {
"type": "boolean"
},
"sourceSystem": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Stock.StockAdjustmentType": {
"enum": [
"WriteUpStock",
"WriteDownStock",
"Stocktake"
],
"type": "string"
},
"SerticaWebApi.Models.Stock.StockMovement": {
"type": "object",
"properties": {
"sourceWarehouseNo": {
"type": "string",
"nullable": true
},
"sourceItemLocationNo": {
"type": "string",
"nullable": true
},
"destinationWarehouseNo": {
"type": "string",
"nullable": true
},
"destinationItemLocationNo": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double"
},
"sourceSystem": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Stock.Warehouse": {
"type": "object",
"properties": {
"warehouseNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"hasSubItemLocations": {
"type": "boolean"
},
"hasSubItems": {
"type": "boolean"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemManagement.LogEntry": {
"type": "object",
"properties": {
"idSeq": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"remarks": {
"type": "string",
"nullable": true
},
"resolved": {
"type": "boolean"
},
"source": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+LogSource"
},
"logType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+LogType"
},
"logLevel": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+LogLevel"
},
"exception": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemManagement.QueueTSTaskItem": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TaskStatus"
},
"nextScheduledRunTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"taskNo": {
"type": "string",
"nullable": true
},
"queueTaskItemNo": {
"type": "string",
"nullable": true
},
"runOnceTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemManagement.TSTask": {
"type": "object",
"properties": {
"taskNo": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"taskType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+StartupParameter"
},
"taskArguments": {
"type": "string",
"nullable": true
},
"frequency": {
"type": "integer",
"format": "int32",
"nullable": true
},
"frequencyType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FrequencyType"
},
"activated": {
"type": "boolean",
"nullable": true
},
"taskStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TaskStatus"
},
"nextRunTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"scheduledTaskType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ScheduledTaskType"
},
"queuedItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemManagement.QueueTSTaskItem"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.AiConnectionInput": {
"type": "object",
"properties": {
"url": {
"type": "string",
"nullable": true
},
"token": {
"type": "string",
"nullable": true
},
"useExistingToken": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+GenericReportType"
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"communicationLanguageNo": {
"type": "string",
"nullable": true
},
"communicationLanguageName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.DynamicReportOptionsOfficeDocumentLink": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+GenericReportType"
},
"documentNo": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"communicationLanguageNo": {
"type": "string",
"nullable": true
},
"communicationLanguageName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.LabelOptionsDocumentLink": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+LabelType"
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.LabelOptionsOfficeDocumentLink": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OfficeLabelType"
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.Options": {
"type": "object",
"properties": {
"componentTypeMandatory": {
"type": "boolean",
"nullable": true
},
"componentLocationMandatory": {
"type": "boolean",
"nullable": true
},
"componentAccountMandatory": {
"type": "boolean",
"nullable": true
},
"componentManufacturerMandatory": {
"type": "boolean",
"nullable": true
},
"componentTypeNoMandatory": {
"type": "boolean",
"nullable": true
},
"jobNameMandatory": {
"type": "boolean",
"nullable": true
},
"jobTriggerMandatory": {
"type": "boolean",
"nullable": true
},
"responsibleMandatoryOnJob": {
"type": "boolean",
"nullable": true
},
"jobGroupMandatory": {
"type": "boolean",
"nullable": true
},
"resourcesMandatory": {
"type": "boolean",
"nullable": true
},
"hideUsersAndUserGroupsAsResources": {
"type": "boolean",
"nullable": true
},
"postponeReasonMandatory": {
"type": "boolean",
"nullable": true
},
"jobPostponementWorkflow": {
"type": "boolean",
"nullable": true
},
"messageExpectedFaultMandatory": {
"type": "boolean",
"nullable": true
},
"warnOnMissingResource": {
"type": "boolean",
"nullable": true
},
"autoGenerateJobNo": {
"type": "boolean"
},
"allowOnlyUseOfUserGroupAsResponsibleOnJob": {
"type": "boolean"
},
"copyComponentAccountToJob": {
"type": "boolean"
},
"jobCriticalRunOnceJobGroupGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"jobBreakdownJobGroupName": {
"type": "string",
"nullable": true
},
"jobBreakdownJobGroupNo": {
"type": "string",
"nullable": true
},
"webExternalCalendarIntegration": {
"type": "boolean"
},
"jobHistoryRemarkMandatory": {
"type": "boolean",
"nullable": true
},
"resourceMandatoryJobHistory": {
"type": "boolean",
"nullable": true
},
"jobHistoryDefaultDoneDate": {
"type": "boolean",
"nullable": true
},
"transferResourceEstimateFromJobToJobHistory": {
"type": "boolean",
"nullable": true
},
"transferSparePartsFromJobToJobHistory": {
"type": "boolean",
"nullable": true
},
"registerHoursOverDays": {
"type": "boolean",
"nullable": true
},
"jobCopyTextToRemarkOnHistory": {
"type": "boolean",
"nullable": true
},
"lockCounterReadingFieldOnJobHistory": {
"type": "boolean",
"nullable": true
},
"automaticallyAddCurrentUserIfMandatory": {
"type": "boolean",
"nullable": true
},
"labelOptionsDocumentLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsDocumentLink"
},
"nullable": true
},
"shipdexManufacturerNo": {
"type": "string",
"nullable": true
},
"shipdexManufacturerName": {
"type": "string",
"nullable": true
},
"shipdexComponentItemNo": {
"type": "string",
"nullable": true
},
"shipdexComponentItemName": {
"type": "string",
"nullable": true
},
"shipdexSuppliesNo": {
"type": "string",
"nullable": true
},
"shipdexSuppliesName": {
"type": "string",
"nullable": true
},
"shipdexSupportEquipmentNo": {
"type": "string",
"nullable": true
},
"shipdexSupportEquipmentName": {
"type": "string",
"nullable": true
},
"shipdexResources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsShipdexResource"
},
"nullable": true
},
"autoGenerateSparePartNo": {
"type": "boolean",
"nullable": true
},
"sparePartPrefix": {
"type": "string",
"nullable": true
},
"sparePartSerialNoLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"defaultItemWarehouseNo": {
"type": "string",
"nullable": true
},
"defaultItemWarehouseName": {
"type": "string",
"nullable": true
},
"itemWarehouseMandatory": {
"type": "boolean",
"nullable": true
},
"itemLocationMandatory": {
"type": "boolean",
"nullable": true
},
"itemMinStockonWarehouseMandatory": {
"type": "boolean",
"nullable": true
},
"stockValue": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+StockValue"
},
"useJobHistoryDoneDateForWarehouseHistory": {
"type": "boolean",
"nullable": true
},
"doNotShowItemsWithoutLocationInItemLocationTree": {
"type": "boolean",
"nullable": true
},
"sparePartImageDimension": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
},
"sparePartImageQuality": {
"type": "integer",
"format": "int32",
"nullable": true
},
"serticaAppShowDocuments": {
"type": "boolean",
"nullable": true
},
"serticaAppShowJobTemplates": {
"type": "boolean",
"nullable": true
},
"serticaAppShowReportedBy": {
"type": "boolean",
"nullable": true
},
"serticaAppShowRemarks": {
"type": "boolean",
"nullable": true
},
"sparePartTextOnStockAdjustments": {
"type": "boolean",
"nullable": true
},
"statusChangeSubjectNo": {
"type": "string",
"nullable": true
},
"statusChangeSubjectName": {
"type": "string",
"nullable": true
},
"statusChangeBodyNo": {
"type": "string",
"nullable": true
},
"statusChangeBodyName": {
"type": "string",
"nullable": true
},
"formApproveSubjectNo": {
"type": "string",
"nullable": true
},
"formApproveSubjectName": {
"type": "string",
"nullable": true
},
"formApproveBodyNo": {
"type": "string",
"nullable": true
},
"formApproveBodyName": {
"type": "string",
"nullable": true
},
"formResponseSubjectNo": {
"type": "string",
"nullable": true
},
"formResponseSubjectName": {
"type": "string",
"nullable": true
},
"formResponseBodyNo": {
"type": "string",
"nullable": true
},
"formResponseBodyName": {
"type": "string",
"nullable": true
},
"formsImageDimension": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
},
"formsImageQuality": {
"type": "integer",
"format": "int32",
"nullable": true
},
"defaultImageDimension": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
},
"defaultImageQuality": {
"type": "integer",
"format": "int32",
"nullable": true
},
"imageSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsImageSetting"
},
"nullable": true
},
"year": {
"type": "string",
"nullable": true
},
"fleetSerialNo": {
"type": "string",
"nullable": true
},
"unitSerialNo": {
"type": "string",
"nullable": true
},
"eposUnitNo": {
"type": "string",
"nullable": true
},
"purchaseOrderAccountMandatory": {
"type": "boolean"
},
"purchaseOrderDepartmentMandatory": {
"type": "boolean"
},
"purchaseOrderComponentMandatory": {
"type": "boolean"
},
"purchaseOrderProjectMandatory": {
"type": "boolean"
},
"standardDeliveryPlaceNo": {
"type": "string",
"nullable": true
},
"standardDeliveryPlaceName": {
"type": "string",
"nullable": true
},
"standardCurrencyNo": {
"type": "string",
"nullable": true
},
"standardCurrencyName": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"requisitionForwardType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+RequisitionForwardType"
},
"disableLocalRequisition": {
"type": "boolean"
},
"descriptionMandatory": {
"type": "boolean"
},
"departmentMandatory": {
"type": "boolean"
},
"measureUnitMandatory": {
"type": "boolean"
},
"requestedDeliveryDateMandatory": {
"type": "boolean"
},
"estimatedCostsMandatoryServiceOrders": {
"type": "boolean"
},
"estimatedCostsMandatoryOtherOrders": {
"type": "boolean"
},
"rfqEmailSubjectNo": {
"type": "string",
"nullable": true
},
"rfqEmailSubjectName": {
"type": "string",
"nullable": true
},
"rfqEmailBodyNo": {
"type": "string",
"nullable": true
},
"rfqEmailBodyName": {
"type": "string",
"nullable": true
},
"purchaseOrderEmailSubjectNo": {
"type": "string",
"nullable": true
},
"purchaseOrderEmailSubjectName": {
"type": "string",
"nullable": true
},
"purchaseOrderEmailBodyNo": {
"type": "string",
"nullable": true
},
"purchaseOrderEmailBodyName": {
"type": "string",
"nullable": true
},
"addComponentInfoToProcurementRequisition": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationRemarksToSupplier": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationSupplier": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationCurrency": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationPositionOrderedQuantity": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationPositionPrice": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationPositionName": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationPositionNumberOfPositions": {
"type": "boolean"
},
"serticaPunchOutID": {
"type": "string",
"nullable": true
},
"punchOutURL": {
"type": "string",
"nullable": true
},
"punchoutAPITokenKey": {
"type": "string",
"nullable": true
},
"punchOutAPITokenHasValue": {
"type": "boolean",
"nullable": true
},
"punchOutRetryConfirmationRequestsForDays": {
"type": "integer",
"format": "int32"
},
"dynamicReportOptionsDocumentLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsDocumentLink"
},
"nullable": true
},
"logbookEventComponentNoMandatory": {
"type": "boolean"
},
"logbookEventSubjectMandatory": {
"type": "boolean"
},
"logbookEventDescriptionMandatory": {
"type": "boolean"
},
"sqlCommandTimeout": {
"type": "integer",
"format": "int32"
},
"orderJobsBy": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+OrderBy"
},
"componentSortOrder": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ComponentSortOrder"
},
"industryApprovalAppAvailabilityJobPostponement": {
"type": "boolean"
},
"industryApprovalAppAvailabilityForm": {
"type": "boolean"
},
"defaultUserLanguageNo": {
"type": "string",
"nullable": true
},
"defaultUserLanguageName": {
"type": "string",
"nullable": true
},
"certificateWindowDueOverdueCalc": {
"type": "boolean",
"nullable": true
},
"inheritableNotificationSettings": {
"type": "boolean",
"nullable": true
},
"arrangeCertificateGroupsBySortOrder": {
"type": "boolean",
"nullable": true
},
"hideCertificateGroupNoInCertificateBrowser": {
"type": "boolean",
"nullable": true
},
"copyCertificateVerificationDateOnRenew": {
"type": "boolean",
"nullable": true
},
"azureADUseAzureADlogin": {
"type": "boolean"
},
"azureADClientId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"azureADTenantId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"azureADAttemptAutomaticlogIn": {
"type": "boolean"
},
"azureADLogUserOutOnExit": {
"type": "boolean"
},
"webOutlookCalendarIntegration": {
"type": "boolean"
},
"autoGenerateDocumentNo": {
"type": "boolean"
},
"checkInShowVersionPopup": {
"type": "boolean"
},
"jobHistoryDataEntryWebTokenExpiration": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobHistoryDataEntryWebTokenExpirationFrequency": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FrequencyType"
},
"fullScreenDashboardRefreshRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.OptionsGlobal": {
"type": "object",
"properties": {
"descriptionMandatory": {
"type": "boolean",
"nullable": true
},
"departmentMandatory": {
"type": "boolean",
"nullable": true
},
"measureUnitMandatory": {
"type": "boolean",
"nullable": true
},
"requestedDeliveryDateMandatory": {
"type": "boolean",
"nullable": true
},
"estimatedCostsMandatoryServiceOrders": {
"type": "boolean",
"nullable": true
},
"estimatedCostsMandatoryOtherOrders": {
"type": "boolean",
"nullable": true
},
"addComponentInfoToProcurementRequisition": {
"type": "boolean",
"nullable": true
},
"automaticallyAddCurrentUserIfMandatory": {
"type": "boolean",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.OptionsImageSetting": {
"type": "object",
"properties": {
"imageArea": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageArea"
},
"imageDimension": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
},
"imageQuality": {
"type": "integer",
"format": "int32",
"nullable": true
},
"optionsGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.OptionsOffice": {
"type": "object",
"properties": {
"serticaAppShowDocuments": {
"type": "boolean",
"nullable": true
},
"serticaAppShowJobTemplates": {
"type": "boolean",
"nullable": true
},
"serticaAppShowReportedBy": {
"type": "boolean",
"nullable": true
},
"serticaAppShowRemarks": {
"type": "boolean",
"nullable": true
},
"defaultImageDimension": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
},
"defaultImageQuality": {
"type": "integer",
"format": "int32",
"nullable": true
},
"convertedUnitCompanies": {
"type": "boolean"
},
"showManufacturerAsSearchButton": {
"type": "boolean"
},
"statusChangeSubjectNo": {
"type": "string",
"nullable": true
},
"statusChangeSubjectName": {
"type": "string",
"nullable": true
},
"statusChangeBodyNo": {
"type": "string",
"nullable": true
},
"statusChangeBodyName": {
"type": "string",
"nullable": true
},
"formApproveSubjectNo": {
"type": "string",
"nullable": true
},
"formApproveSubjectName": {
"type": "string",
"nullable": true
},
"formApproveBodyNo": {
"type": "string",
"nullable": true
},
"formApproveBodyName": {
"type": "string",
"nullable": true
},
"formResponseSubjectNo": {
"type": "string",
"nullable": true
},
"formResponseSubjectName": {
"type": "string",
"nullable": true
},
"formResponseBodyNo": {
"type": "string",
"nullable": true
},
"formResponseBodyName": {
"type": "string",
"nullable": true
},
"imageSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeImageSetting"
},
"nullable": true
},
"electronicLogbookSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeElectronicLogbookSetting"
},
"nullable": true
},
"labelOptionsOfficeDocumentLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.LabelOptionsOfficeDocumentLink"
},
"nullable": true
},
"approvalAppAvailabilityJobPostponement": {
"type": "boolean",
"nullable": true
},
"approvalAppAvailabilityEventPostponement": {
"type": "boolean",
"nullable": true
},
"approvalAppAvailabilityPOPriceApproval": {
"type": "boolean",
"nullable": true
},
"approvalAppAvailabilityInvoiceApproval": {
"type": "boolean",
"nullable": true
},
"approvalAppAvailabilityForm": {
"type": "boolean",
"nullable": true
},
"approvePurchaseOrderInStandardCurrency": {
"type": "boolean",
"nullable": true
},
"showReadUnreadInMSBrowser": {
"type": "boolean",
"nullable": true
},
"webExternalCalendarIntegration": {
"type": "boolean"
},
"ignoreDocumentTransactionMaxSizeCertificateDocuments": {
"type": "boolean",
"nullable": true
},
"certificateWindowDueOverdueCalc": {
"type": "boolean",
"nullable": true
},
"inheritableNotificationSettings": {
"type": "boolean",
"nullable": true
},
"arrangeCertificateGroupsBySortOrder": {
"type": "boolean",
"nullable": true
},
"hideCertificateGroupNoInCertificateBrowser": {
"type": "boolean",
"nullable": true
},
"copyCertificateVerificationDateOnRenew": {
"type": "boolean",
"nullable": true
},
"dynamicReportOptionsOfficeDocumentLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.DynamicReportOptionsOfficeDocumentLink"
},
"nullable": true
},
"defaultUserLanguageNo": {
"type": "string",
"nullable": true
},
"defaultUserLanguageName": {
"type": "string",
"nullable": true
},
"daysToDeleteMail": {
"type": "integer",
"format": "int32"
},
"enableMailClean": {
"type": "boolean"
},
"autoGenerateSparePartNo": {
"type": "boolean",
"nullable": true
},
"sparePartPrefix": {
"type": "string",
"nullable": true
},
"sparePartSerialNoLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sparePartSFICodeMandatory": {
"type": "boolean",
"nullable": true
},
"standardCurrencyNo": {
"type": "string",
"nullable": true
},
"standardCurrencyName": {
"type": "string",
"nullable": true
},
"showWarningWhenItemIsRequestedOrOrdered": {
"type": "boolean"
},
"purchaseOrderAllowChangesInPriceApprovalState": {
"type": "boolean"
},
"askForSendMethod": {
"type": "boolean"
},
"sendMethod": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+SendMethod"
},
"rfqEmailSubjectNo": {
"type": "string",
"nullable": true
},
"rfqEmailSubjectName": {
"type": "string",
"nullable": true
},
"rfqEmailBodyNo": {
"type": "string",
"nullable": true
},
"rfqEmailBodyName": {
"type": "string",
"nullable": true
},
"purchaseOrderEmailSubjectNo": {
"type": "string",
"nullable": true
},
"purchaseOrderEmailSubjectName": {
"type": "string",
"nullable": true
},
"purchaseOrderEmailBodyNo": {
"type": "string",
"nullable": true
},
"purchaseOrderEmailBodyName": {
"type": "string",
"nullable": true
},
"esgShowCO2NumbersOnREQRFQPO": {
"type": "boolean"
},
"generateConnectPasswordSubjectNo": {
"type": "string",
"nullable": true
},
"generateConnectPasswordSubjectName": {
"type": "string",
"nullable": true
},
"generateConnectPasswordBodyNo": {
"type": "string",
"nullable": true
},
"generateConnectPasswordBodyName": {
"type": "string",
"nullable": true
},
"webQuoteRfqEmailHeaderNo": {
"type": "string",
"nullable": true
},
"webQuoteRfqEmailHeaderName": {
"type": "string",
"nullable": true
},
"webQuoteRfqEmailBodyNo": {
"type": "string",
"nullable": true
},
"webQuoteRfqEmailBodyName": {
"type": "string",
"nullable": true
},
"webQuotePurchaseOrderEmailHeaderNo": {
"type": "string",
"nullable": true
},
"webQuotePurchaseOrderEmailHeaderName": {
"type": "string",
"nullable": true
},
"webQuotePurchaseOrderEmailBodyNo": {
"type": "string",
"nullable": true
},
"webQuotePurchaseOrderEmailBodyName": {
"type": "string",
"nullable": true
},
"disableDeliveryCostsInIndividualPositionCalculationInCalculatePO": {
"type": "boolean"
},
"usePortPricesInCalculatePO": {
"type": "boolean"
},
"useSupplierPricesforMissingPortPrices": {
"type": "boolean"
},
"invoiceManagementAllowMultiplePurchaseOrders": {
"type": "boolean"
},
"invoiceManagementOnlyAllowInvoicingOfReceivedItems": {
"type": "boolean"
},
"warnIfMatchedAmountsHasDifferences": {
"type": "boolean"
},
"invoiceManagementSetApproverResponsibleOnApproval": {
"type": "boolean"
},
"invoiceManagementForceSetPOInvoiceStatusOnApproval": {
"type": "boolean"
},
"invoiceManagementResponseLogMandatory": {
"type": "boolean"
},
"invoiceManagementSpotCheckPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceManagementAutomatchLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceManagementDaysToRetryAutomatching": {
"type": "integer",
"format": "int32",
"nullable": true
},
"imInvoiceAllowAutoMatchWithRejectedPositions": {
"type": "boolean"
},
"ignoreRejectedPositionsInAutomatch": {
"type": "boolean"
},
"allowAutomatchForPartlyReceivedPurchaseOrders": {
"type": "boolean"
},
"doNotAutomatchInvoicesWithBlockSupplier": {
"type": "boolean"
},
"automatchApproverNo": {
"type": "string",
"nullable": true
},
"automatchApproverName": {
"type": "string",
"nullable": true
},
"invoiceManagementAllowedPercentageDeviation": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceManagementMaximumAllowedMonetaryDeviation": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceManagementMaximumAllowedVATMonetaryDeviation": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceManagementAutomaticDeviationCostNo": {
"type": "string",
"nullable": true
},
"invoiceManagementAutomaticDeviationCostName": {
"type": "string",
"nullable": true
},
"invoiceManagementManualDeviationCostNo": {
"type": "string",
"nullable": true
},
"invoiceManagementManualDeviationCostName": {
"type": "string",
"nullable": true
},
"updateSupplierItemPriceWhenApproveInvoice": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+UpdateSupplierItemPriceWhenApproveInvoice"
},
"updateOnAutomatchForInvoice": {
"type": "boolean"
},
"noPriceUpdateOnContractedItemsForInvoice": {
"type": "boolean"
},
"invoiceManagementChangeResponsibleSendNotification": {
"type": "boolean"
},
"invoiceManagementChangeResponsibleManualChangesOnly": {
"type": "boolean"
},
"invoiceManagementChangeResponsibleSubjectNo": {
"type": "string",
"nullable": true
},
"invoiceManagementChangeResponsibleSubjectName": {
"type": "string",
"nullable": true
},
"invoiceManagementChangeResponsibleBodyNo": {
"type": "string",
"nullable": true
},
"invoiceManagementChangeResponsibleBodyName": {
"type": "string",
"nullable": true
},
"invoiceManagementForwardForApprovalSendNotification": {
"type": "boolean"
},
"invoiceManagementForwardForApprovalSubjectNo": {
"type": "string",
"nullable": true
},
"invoiceManagementForwardForApprovalSubjectName": {
"type": "string",
"nullable": true
},
"invoiceManagementForwardForApprovalBodyNo": {
"type": "string",
"nullable": true
},
"invoiceManagementForwardForApprovalBodyName": {
"type": "string",
"nullable": true
},
"invoiceManagementAutomatchCompleteSendNotification": {
"type": "boolean"
},
"invoiceManagementAutomatchCompleteSubjectNo": {
"type": "string",
"nullable": true
},
"invoiceManagementAutomatchCompleteSubjectName": {
"type": "string",
"nullable": true
},
"invoiceManagementAutomatchCompleteBodyNo": {
"type": "string",
"nullable": true
},
"invoiceManagementAutomatchCompleteBodyName": {
"type": "string",
"nullable": true
},
"invoiceManagementVerificationSendNotification": {
"type": "boolean"
},
"invoiceManagementVerificationSubjectNo": {
"type": "string",
"nullable": true
},
"invoiceManagementVerificationSubjectName": {
"type": "string",
"nullable": true
},
"invoiceManagementVerificationBodyNo": {
"type": "string",
"nullable": true
},
"invoiceManagementVerificationBodyName": {
"type": "string",
"nullable": true
},
"defaultCompanyNo": {
"type": "string",
"nullable": true
},
"defaultCompanyName": {
"type": "string",
"nullable": true
},
"procurementMailAccountNo": {
"type": "string",
"nullable": true
},
"procurementMailAccountDescription": {
"type": "string",
"nullable": true
},
"purchaseOrderApprovalInvalidationRemarksToSupplier": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationSupplier": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationCurrency": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationDiscount": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationPositionOrderedQuantity": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationPositionPrice": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationPositionDiscount": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationPositionMeasureUnit": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationPositionName": {
"type": "boolean"
},
"purchaseOrderApprovalInvalidationPositionNumberOfPositions": {
"type": "boolean"
},
"evaluationReceivingRequisition": {
"type": "boolean"
},
"evaluationRejectingRequestForQuote": {
"type": "boolean"
},
"evaluationPlacingPurchaseOrder": {
"type": "boolean"
},
"evaluationReceivingPurchaseOrder": {
"type": "boolean"
},
"evaluationImInvoice": {
"type": "boolean"
},
"evaluationEvaluateSupplier": {
"type": "boolean"
},
"evaluationTransitReceiving": {
"type": "boolean"
},
"evaluationReceivingShipment": {
"type": "boolean"
},
"evaluationPeriods": {
"type": "integer",
"format": "int32",
"nullable": true
},
"suggestActions": {
"type": "boolean",
"nullable": true
},
"evaluationThresholdSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.SystemOptions.OptionsOfficeEvaluationThresholdSetting"
},
"nullable": true
},
"serticaPunchOutID": {
"type": "string",
"nullable": true
},
"punchOutURL": {
"type": "string",
"nullable": true
},
"punchoutAPITokenKey": {
"type": "string",
"nullable": true
},
"punchOutAPITokenHasValue": {
"type": "boolean",
"nullable": true
},
"punchOutRetryConfirmationRequestsForDays": {
"type": "integer",
"format": "int32"
},
"distributionWeightMeasureUnitNo": {
"type": "string",
"nullable": true
},
"distributionWeightMeasureUnitName": {
"type": "string",
"nullable": true
},
"distributionDimensionUnitNo": {
"type": "string",
"nullable": true
},
"distributionDimensionUnitName": {
"type": "string",
"nullable": true
},
"distributionDimensionUnitMandatory": {
"type": "boolean",
"nullable": true
},
"notifyIfTransitReceivingToADeliveryPlaceThatIsNotTheUnitDefault": {
"type": "boolean",
"nullable": true
},
"autoGenerateCarrierNo": {
"type": "boolean",
"nullable": true
},
"carrierNoPrefix": {
"type": "string",
"nullable": true
},
"carrierNoYear": {
"type": "string",
"nullable": true
},
"carrierNoSerialNoLength": {
"type": "integer",
"format": "int32"
},
"autoGenerateShipmentNo": {
"type": "boolean",
"nullable": true
},
"shipmentNoPrefix": {
"type": "string",
"nullable": true
},
"shipmentNoYear": {
"type": "string",
"nullable": true
},
"shipmentNoSerialNoLength": {
"type": "integer",
"format": "int32"
},
"selectUnitOnShipment": {
"type": "boolean",
"nullable": true
},
"distributionMailAccountNo": {
"type": "string",
"nullable": true
},
"distributionMailAccountDescription": {
"type": "string",
"nullable": true
},
"distributionEmailSubject": {
"type": "string",
"nullable": true
},
"distributionEmailSubjectNo": {
"type": "string",
"nullable": true
},
"distributionEmailBody": {
"type": "string",
"nullable": true
},
"distributionEmailBodyNo": {
"type": "string",
"nullable": true
},
"freightForwarderEmailSubject": {
"type": "string",
"nullable": true
},
"freightForwarderEmailSubjectNo": {
"type": "string",
"nullable": true
},
"freightForwarderEmailBody": {
"type": "string",
"nullable": true
},
"freightForwarderEmailBodyNo": {
"type": "string",
"nullable": true
},
"urgentPOReceivedMailSubject": {
"type": "string",
"nullable": true
},
"urgentPOReceivedMailSubjectNo": {
"type": "string",
"nullable": true
},
"urgentPOReceivedMailBody": {
"type": "string",
"nullable": true
},
"urgentPOReceivedMailBodyNo": {
"type": "string",
"nullable": true
},
"urgentPOReceivedEmailReceivers": {
"type": "string",
"nullable": true
},
"urgentPOReceivedAddPurchaserToEmailRecipient": {
"type": "boolean"
},
"urgentPOReceivedSendMail": {
"type": "boolean"
},
"azureADUseAzureADlogin": {
"type": "boolean"
},
"azureADClientId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"azureADTenantId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"azureADAttemptAutomaticlogIn": {
"type": "boolean"
},
"azureADLogUserOutOnExit": {
"type": "boolean"
},
"webOutlookCalendarIntegration": {
"type": "boolean"
},
"autoGenerateRequestForQuoteNo": {
"type": "boolean",
"nullable": true
},
"requestForQuotePrefix": {
"type": "string",
"nullable": true
},
"requestForQuoteYear": {
"type": "string",
"nullable": true
},
"requestForQuoteSerialNoLength": {
"type": "integer",
"format": "int32"
},
"requestForQuoteAdviceByDays": {
"type": "integer",
"format": "int32"
},
"requestForQuoteAdviceByDaysUrgent": {
"type": "integer",
"format": "int32"
},
"autoGenerateDocumentNo": {
"type": "boolean"
},
"checkInShowVersionPopup": {
"type": "boolean"
},
"fullScreenDashboardRefreshRate": {
"type": "integer",
"format": "int32",
"nullable": true
},
"vesselReportingAzureBlobStorageConnectionString": {
"type": "string",
"nullable": true
},
"vesselReportingAzureBlobStorageContainerName": {
"type": "string",
"nullable": true
},
"webDashboardPowerBIClientId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webDashboardPowerBITenantId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webDashboardPowerBIClientSecret": {
"type": "string",
"nullable": true
},
"webDashboardPowerBIClientSecretHasValue": {
"type": "boolean",
"nullable": true
},
"sqlCommandTimeout": {
"type": "integer",
"format": "int32"
},
"spireApiKey": {
"type": "string",
"nullable": true
},
"spireApiKeyHasValue": {
"type": "boolean",
"nullable": true
},
"serticaWebSiteUrl": {
"type": "string",
"nullable": true
},
"aiapiUrl": {
"type": "string",
"nullable": true
},
"aiapiToken": {
"type": "string",
"nullable": true
},
"aiapiTokenHasValue": {
"type": "boolean",
"nullable": true
},
"purchaseOrderForwardForPriceApprovalSupplierMandatory": {
"type": "boolean"
},
"purchaseOrderForwardForPriceApprovalDeliveryDateMandatory": {
"type": "boolean"
},
"purchaseOrderForwardForPriceApprovalDepartmentMandatory": {
"type": "boolean"
},
"purchaseOrderForwardForPriceApprovalDeliveryPlaceMandatory": {
"type": "boolean"
},
"purchaseOrderForwardForPriceApprovalAccountMandatory": {
"type": "boolean"
},
"purchaseOrderSetPurchaserOnCreate": {
"type": "boolean"
},
"purchaseOrderSetPurchaserOnPlaceOrder": {
"type": "boolean"
},
"purchaseOrderSetPurchaserOnForwardForPriceApproval": {
"type": "boolean"
},
"purchaseOrderSetPurchaserOnApprovalInvalidation": {
"type": "boolean"
},
"purchaseOrderApprovalSendNotification": {
"type": "boolean"
},
"priceApprovalSubjectNo": {
"type": "string",
"nullable": true
},
"priceApprovalSubjectName": {
"type": "string",
"nullable": true
},
"priceApprovalBodyNo": {
"type": "string",
"nullable": true
},
"priceApprovalBodyName": {
"type": "string",
"nullable": true
},
"reminderEmailSubjectNo": {
"type": "string",
"nullable": true
},
"reminderEmailSubjectName": {
"type": "string",
"nullable": true
},
"reminderEmailBodyNo": {
"type": "string",
"nullable": true
},
"reminderEmailBodyName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.OptionsOfficeElectronicLogbookSetting": {
"type": "object",
"properties": {
"logbook": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ElectronicLogbookLogbook"
},
"maxSignLevel": {
"type": "integer",
"format": "int32",
"nullable": true
},
"signLevel1RoleNo": {
"type": "string",
"nullable": true
},
"signLevel1RoleName": {
"type": "string",
"nullable": true
},
"signLevel2RoleNo": {
"type": "string",
"nullable": true
},
"signLevel2RoleName": {
"type": "string",
"nullable": true
},
"signLevel3RoleNo": {
"type": "string",
"nullable": true
},
"signLevel3RoleName": {
"type": "string",
"nullable": true
},
"signLevel4RoleNo": {
"type": "string",
"nullable": true
},
"signLevel4RoleName": {
"type": "string",
"nullable": true
},
"signLevel5RoleNo": {
"type": "string",
"nullable": true
},
"signLevel5RoleName": {
"type": "string",
"nullable": true
},
"optionsGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.OptionsOfficeEvaluationThresholdSetting": {
"type": "object",
"properties": {
"maximumValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minimumValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"suggestAction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AddressClassificationAction"
},
"optionsOfficeGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"addressClassificationName": {
"type": "string",
"nullable": true
},
"addressClassificationNo": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.OptionsOfficeImageSetting": {
"type": "object",
"properties": {
"imageArea": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageArea"
},
"imageDimension": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ImageDimension"
},
"imageQuality": {
"type": "integer",
"format": "int32",
"nullable": true
},
"optionsGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.OptionsShipdexResource": {
"type": "object",
"properties": {
"resourceNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"specification": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipdexSpecification"
},
"memberArea": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+ShipdexMemberArea"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.SystemOptions.PunchoutConnectionInput": {
"type": "object",
"properties": {
"punchoutID": {
"type": "string",
"nullable": true
},
"punchoutURL": {
"type": "string",
"nullable": true
},
"punchoutTokenKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.TechnicalAccount.TechnicalAccount": {
"type": "object",
"properties": {
"technicalAccountNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"materialNumber": {
"type": "string",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"purchaseTypesAsString": {
"type": "string",
"nullable": true
},
"companiesAsString": {
"type": "string",
"nullable": true
},
"purchaseTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccountPurchaseType"
},
"nullable": true
},
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TechnicalAccount.TechnicalAccountCompany"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.TechnicalAccount.TechnicalAccountCompany": {
"type": "object",
"properties": {
"technicalAccountNo": {
"type": "string",
"nullable": true
},
"technicalAccountName": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.TechnicalAccount.TechnicalAccountPurchaseType": {
"type": "object",
"properties": {
"technicalAccountNo": {
"type": "string",
"nullable": true
},
"technicalAccountName": {
"type": "string",
"nullable": true
},
"materialNumber": {
"type": "string",
"nullable": true
},
"purchaseTypeNo": {
"type": "string",
"nullable": true
},
"purchaseTypeName": {
"type": "string",
"nullable": true
},
"accountNo": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Transactions.DataTransaction": {
"type": "object",
"properties": {
"transactionNo": {
"type": "integer",
"format": "int32"
},
"transactionOrder": {
"type": "integer",
"format": "int32"
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TransactionStatus"
},
"direction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TransactionDirection"
},
"retransmitCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Transactions.DataTransactionData": {
"type": "object",
"properties": {
"transactionOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"objectGUID": {
"type": "string",
"nullable": true
},
"objectLiveGuid": {
"type": "string",
"nullable": true
},
"objectTable": {
"type": "string",
"nullable": true
},
"typeName": {
"type": "string",
"nullable": true
},
"transactionGuid": {
"type": "string",
"nullable": true
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Transactions.DocumentTransaction": {
"type": "object",
"properties": {
"transactionNo": {
"type": "integer",
"format": "int32"
},
"transactionOrder": {
"type": "integer",
"format": "int32"
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TransactionStatus"
},
"direction": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+TransactionDirection"
},
"documentLiveObjectGuid": {
"type": "string",
"format": "uuid"
},
"objectGuid": {
"type": "string",
"nullable": true
},
"typeName": {
"type": "string",
"nullable": true
},
"forceExport": {
"type": "boolean"
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"objectTable": {
"type": "string",
"nullable": true
},
"retransmitCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Transactions.TransactionQueue": {
"type": "object",
"properties": {
"idSeq": {
"type": "string",
"nullable": true
},
"objectGUID": {
"type": "string",
"nullable": true
},
"objectTable": {
"type": "string",
"nullable": true
},
"typeName": {
"type": "string",
"nullable": true
},
"versionNo": {
"type": "string",
"nullable": true
},
"objectLiveGuid": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.TreeStructure.NodeType": {
"enum": [
"Component",
"DisabledComponent",
"JobFolder",
"Job",
"RecurringJobFolder",
"RecurringJob",
"RunOnceJobFolder",
"RunOnceJob",
"JobHistoryYear",
"JobHistory"
],
"type": "string"
},
"SerticaWebApi.Models.TreeStructure.TreeStructureNode": {
"type": "object",
"properties": {
"hasChildren": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"visibleKey": {
"type": "string",
"nullable": true
},
"critical": {
"type": "boolean"
},
"disabled": {
"type": "boolean",
"nullable": true
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.NodeType"
},
"excludeFromJobUse": {
"type": "boolean"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.TreeStructure.TreeStructureNode"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.ClassSociety": {
"type": "object",
"properties": {
"classSocietyNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.Flag": {
"type": "object",
"properties": {
"flagNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"orbIPartIIIFlag": {
"type": "boolean",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.Unit": {
"type": "object",
"properties": {
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"versionNo": {
"type": "string",
"nullable": true
},
"convertedToMultipleJobGroups": {
"type": "boolean",
"nullable": true
},
"imoNo": {
"type": "string",
"nullable": true
},
"vesselTypeNo": {
"type": "string",
"nullable": true
},
"vesselTypeName": {
"type": "string",
"nullable": true
},
"technicalResponsibleNo": {
"type": "string",
"nullable": true
},
"technicalResponsibleName": {
"type": "string",
"nullable": true
},
"remark": {
"type": "string",
"nullable": true
},
"corporateEntity": {
"type": "string",
"nullable": true
},
"businessUnit": {
"type": "string",
"nullable": true
},
"licenseTypeGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"licenseTypeName": {
"type": "string",
"nullable": true
},
"laidUp": {
"type": "boolean",
"nullable": true
},
"testUnit": {
"type": "boolean",
"nullable": true
},
"inactiveUnit": {
"type": "boolean",
"nullable": true
},
"unitExportTimestamp": {
"type": "string",
"format": "date-time",
"nullable": true
},
"sqlServerVersionNumber": {
"type": "string",
"nullable": true
},
"sqlServerVersionName": {
"type": "string",
"nullable": true
},
"sqlServerEdition": {
"type": "string",
"nullable": true
},
"isSqlExpress": {
"type": "boolean"
},
"databaseSizeInKb": {
"type": "integer",
"format": "int64",
"nullable": true
},
"superintendentNo": {
"type": "string",
"nullable": true
},
"superintendentName": {
"type": "string",
"nullable": true
},
"superintendentPhone": {
"type": "string",
"nullable": true
},
"superintendentEmail": {
"type": "string",
"nullable": true
},
"marineSuperintendentNo": {
"type": "string",
"nullable": true
},
"marineSuperintendentName": {
"type": "string",
"nullable": true
},
"marineSuperintendentPhone": {
"type": "string",
"nullable": true
},
"marineSuperintendentEmail": {
"type": "string",
"nullable": true
},
"mailAddress": {
"type": "string",
"nullable": true
},
"satCNo": {
"type": "string",
"nullable": true
},
"satTelNo": {
"type": "string",
"nullable": true
},
"mobilePhoneNo": {
"type": "string",
"nullable": true
},
"satFaxNo": {
"type": "string",
"nullable": true
},
"flagNo": {
"type": "string",
"nullable": true
},
"flagName": {
"type": "string",
"nullable": true
},
"homeport": {
"type": "string",
"nullable": true
},
"grossTonnage": {
"type": "number",
"format": "double",
"nullable": true
},
"dateOfFirstRegistry": {
"type": "string",
"format": "date-time",
"nullable": true
},
"officialNo": {
"type": "string",
"nullable": true
},
"callSign": {
"type": "string",
"nullable": true
},
"mmsi": {
"type": "string",
"nullable": true
},
"firstFrameNumber": {
"type": "number",
"format": "double"
},
"lastFrameNumber": {
"type": "number",
"format": "double"
},
"darso": {
"type": "string",
"nullable": true
},
"modelDesignID": {
"type": "string",
"nullable": true
},
"modelDesignText": {
"type": "string",
"nullable": true
},
"forSale": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+UnitForSale"
},
"warValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"hullAndMachineryValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jointVenturePartner": {
"type": "string",
"nullable": true
},
"mortgage": {
"type": "string",
"nullable": true
},
"coInsured": {
"type": "string",
"nullable": true
},
"coInsuredAddress": {
"type": "string",
"nullable": true
},
"classSocietyNo": {
"type": "string",
"nullable": true
},
"classSocietyName": {
"type": "string",
"nullable": true
},
"classNotation": {
"type": "string",
"nullable": true
},
"harmonizedSurveyDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"classID": {
"type": "string",
"nullable": true
},
"safetyManagementSystemID": {
"type": "string",
"nullable": true
},
"safetyManagementSystemText": {
"type": "string",
"nullable": true
},
"owner": {
"type": "string",
"nullable": true
},
"manager": {
"type": "string",
"nullable": true
},
"performanceTarget": {
"type": "number",
"format": "double",
"nullable": true
},
"ownershipTypeID": {
"type": "string",
"nullable": true
},
"ownershipTypeText": {
"type": "string",
"nullable": true
},
"managementTypeID": {
"type": "string",
"nullable": true
},
"managementTypeText": {
"type": "string",
"nullable": true
},
"yard": {
"type": "string",
"nullable": true
},
"yardNo": {
"type": "string",
"nullable": true
},
"keelLaid": {
"type": "string",
"format": "date-time",
"nullable": true
},
"builtDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ageInYears": {
"type": "string",
"nullable": true
},
"countryCodeNo": {
"type": "string",
"nullable": true
},
"countryCodeName": {
"type": "string",
"nullable": true
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
},
"nullable": true
},
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany"
},
"nullable": true
},
"documentClasses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitDocumentClass"
},
"nullable": true
},
"functionAreas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.FunctionArea.FunctionAreaUnit"
},
"nullable": true
},
"hasAccess": {
"type": "boolean"
},
"incineratorPresent": {
"type": "boolean",
"nullable": true
},
"incineratorRate": {
"type": "number",
"format": "double",
"nullable": true
},
"incineratorInstallationYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"owsPresent": {
"type": "boolean",
"nullable": true
},
"owsRate": {
"type": "number",
"format": "double",
"nullable": true
},
"bwmpPresent": {
"type": "boolean",
"nullable": true
},
"bwCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"ballastWaterManagementCertificate": {
"type": "string",
"nullable": true
},
"bpAhead": {
"type": "integer",
"format": "int32",
"nullable": true
},
"bpAstern": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ballastWaterCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"freshWaterCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"fuelMGOCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"lubeOilCapacity": {
"type": "number",
"format": "double",
"nullable": true
},
"lengthWaterline": {
"type": "number",
"format": "double",
"nullable": true
},
"depthMoulded": {
"type": "number",
"format": "double",
"nullable": true
},
"economicalSpeed": {
"type": "number",
"format": "double",
"nullable": true
},
"aftDeckArea": {
"type": "number",
"format": "double",
"nullable": true
},
"beam": {
"type": "number",
"format": "double",
"nullable": true
},
"displacement": {
"type": "number",
"format": "double",
"nullable": true
},
"totalKW": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ownerCompanyNo": {
"type": "string",
"nullable": true
},
"ownerCompanyName": {
"type": "string",
"nullable": true
},
"ownerCompanyInternalEntity": {
"type": "boolean",
"nullable": true
},
"ownerCompanyCountryCodeNo": {
"type": "string",
"nullable": true
},
"managerCompanyNo": {
"type": "string",
"nullable": true
},
"managerCompanyName": {
"type": "string",
"nullable": true
},
"managerCompanyInternalEntity": {
"type": "boolean",
"nullable": true
},
"managerCompanyCountryCodeNo": {
"type": "string",
"nullable": true
},
"byManagementAgreement": {
"type": "boolean",
"nullable": true
},
"managementOfficeNo": {
"type": "string",
"nullable": true
},
"managementOfficeName": {
"type": "string",
"nullable": true
},
"operatorCompanyNo": {
"type": "string",
"nullable": true
},
"operatorCompanyName": {
"type": "string",
"nullable": true
},
"operatorCompanyInternalEntity": {
"type": "boolean",
"nullable": true
},
"operatorCompanyCountryCodeNo": {
"type": "string",
"nullable": true
},
"operationID": {
"type": "string",
"nullable": true
},
"operationText": {
"type": "string",
"nullable": true
},
"statusAnalysisDataID": {
"type": "string",
"nullable": true
},
"statusAnalysisDataText": {
"type": "string",
"nullable": true
},
"regionNo": {
"type": "string",
"nullable": true
},
"regionName": {
"type": "string",
"nullable": true
},
"subRegionNo": {
"type": "string",
"nullable": true
},
"subRegionName": {
"type": "string",
"nullable": true
},
"bareboatCharterer": {
"type": "string",
"nullable": true
},
"charteringArrangement": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.UnitCompany": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"standardText1No": {
"type": "string",
"nullable": true
},
"standardText1Text": {
"type": "string",
"nullable": true
},
"standardText2No": {
"type": "string",
"nullable": true
},
"standardText2Text": {
"type": "string",
"nullable": true
},
"standardText3No": {
"type": "string",
"nullable": true
},
"standardText3Text": {
"type": "string",
"nullable": true
},
"default": {
"type": "boolean",
"nullable": true
},
"externalReference1": {
"type": "string",
"nullable": true
},
"externalReference2": {
"type": "string",
"nullable": true
},
"externalReference3": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.UnitCompany2": {
"type": "object",
"properties": {
"unitCompanyNo": {
"type": "string",
"nullable": true
},
"referencedUnitNo": {
"type": "string",
"nullable": true
},
"referencedUnitName": {
"type": "string",
"nullable": true
},
"companyNo": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"mailAccountNo": {
"type": "string",
"nullable": true
},
"mailAccountDescription": {
"type": "string",
"nullable": true
},
"default": {
"type": "boolean",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"externalReference1": {
"type": "string",
"nullable": true
},
"externalReference2": {
"type": "string",
"nullable": true
},
"externalReference3": {
"type": "string",
"nullable": true
},
"standardTexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitCompany2StandardText"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.UnitCompany2StandardText": {
"type": "object",
"properties": {
"unitCompanyNo": {
"type": "string",
"nullable": true
},
"standardTextNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"addToRequisition": {
"type": "boolean",
"nullable": true
},
"addToRequestForQuote": {
"type": "boolean",
"nullable": true
},
"addToPurchaseOrder": {
"type": "boolean",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.UnitDocumentClass": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"documentClassNo": {
"type": "string",
"nullable": true
},
"documentClassName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.UnitGroup": {
"type": "object",
"properties": {
"unitGroupNo": {
"type": "string",
"nullable": true
},
"parentUnitGroupNo": {
"type": "string",
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UnitManagement.UnitGroupUnit"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.UnitGroupUnit": {
"type": "object",
"properties": {
"unitGroupNo": {
"type": "string",
"nullable": true
},
"referredUnitNo": {
"type": "string",
"nullable": true
},
"referredUnitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.UnitLicenseType": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.UnitUserRoleLogin": {
"type": "object",
"properties": {
"roleNo": {
"type": "string",
"nullable": true
},
"roleName": {
"type": "string",
"nullable": true
},
"resourceNo": {
"type": "string",
"nullable": true
},
"resourceName": {
"type": "string",
"nullable": true
},
"lastLogin": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UnitManagement.VesselType": {
"type": "object",
"properties": {
"vesselTypeNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.CombinedUserRole2": {
"type": "object",
"properties": {
"no": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"inactive": {
"type": "boolean"
},
"access": {
"type": "boolean"
},
"unitsAsString": {
"type": "string",
"nullable": true
},
"unitNamesAsString": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.InextiaUserRight": {
"type": "object",
"properties": {
"inextiaKey": {
"type": "string",
"nullable": true
},
"inextiaParentKey": {
"type": "string",
"nullable": true
},
"indexType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.UserManagement.InextiaUserRightIndexType"
},
"nameTextID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"descriptionTextID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"userRightKey": {
"type": "string",
"nullable": true
},
"userRightGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"rightID": {
"type": "integer",
"format": "int32"
},
"userGroupGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"userRightResourceGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"hasUserRight": {
"type": "boolean",
"nullable": true
},
"userGroupNo": {
"type": "string",
"nullable": true
},
"userGroupName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.InextiaUserSetting": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.Role": {
"type": "object",
"properties": {
"roleNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"parentRoleNo": {
"type": "string",
"nullable": true
},
"parentRoleName": {
"type": "string",
"nullable": true
},
"userGroupNo": {
"type": "string",
"nullable": true
},
"userGroupName": {
"type": "string",
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.RoleUnit"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.RoleUnit": {
"type": "object",
"properties": {
"roleNo": {
"type": "string",
"nullable": true
},
"roleName": {
"type": "string",
"nullable": true
},
"referencedUnitNo": {
"type": "string",
"nullable": true
},
"referencedUnitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.User": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"login": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"access": {
"type": "boolean",
"nullable": true
},
"lastLogin": {
"type": "string",
"format": "date-time",
"nullable": true
},
"userGroupNo": {
"type": "string",
"nullable": true
},
"userGroupName": {
"type": "string",
"nullable": true
},
"userGroupGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sectionNo": {
"type": "string",
"nullable": true
},
"sectionName": {
"type": "string",
"nullable": true
},
"languageNo": {
"type": "string",
"nullable": true
},
"languageName": {
"type": "string",
"nullable": true
},
"languageGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"suspendEmailRequiredRule": {
"type": "boolean"
},
"userAvailableAsResource": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"userAvailableAsResourceOnJobHistory": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"userAvailableAsAssignee": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"userAvailableAsResponsible": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"showProcurementTaskListAtLogin": {
"type": "boolean",
"nullable": true
},
"windowsUserName": {
"type": "string",
"nullable": true
},
"unitsAsString": {
"type": "string",
"nullable": true
},
"unitNamesAsString": {
"type": "string",
"nullable": true
},
"forcePasswordChange": {
"type": "boolean",
"nullable": true
},
"totpEnabled": {
"type": "boolean"
},
"password": {
"type": "string",
"nullable": true
},
"embarkedOnUnitNo": {
"type": "string",
"nullable": true
},
"embarkedOnUnitName": {
"type": "string",
"nullable": true
},
"userEmbarkationStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+UserEmbarkationStatus"
},
"embarkationDisembarkationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"embarkationDisembarkationDateOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserUnit"
},
"nullable": true
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserRoleRelation"
},
"nullable": true
},
"resourceOnUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserResourceOnUnit"
},
"nullable": true
},
"assigneeOnUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserAssigneeOnUnit"
},
"nullable": true
},
"responsibleOnUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserResponsibleOnUnit"
},
"nullable": true
},
"jobHistoryResourceOnUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserJobHistoryResourceOnUnit"
},
"nullable": true
},
"servicePrincipalMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserServicePrincipalMapping"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserAssigneeOnUnit": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserGroup": {
"type": "object",
"properties": {
"userGroupNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"usersAsString": {
"type": "string",
"nullable": true
},
"userNamesAsString": {
"type": "string",
"nullable": true
},
"userGroupAvailableAsResource": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"userGroupAvailableAsResourceOnJobHistory": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"userGroupAvailableAsAssignee": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"userGroupAvailableAsResponsible": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AvailableAsResource"
},
"userRights": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.InextiaUserRight"
},
"nullable": true
},
"resourceOnUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUnit"
},
"nullable": true
},
"userGroupLimitations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupUserGroupLimitation"
},
"nullable": true
},
"assigneeOnUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupAssigneeOnUnit"
},
"nullable": true
},
"responsibleOnUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupResponsibleOnUnit"
},
"nullable": true
},
"jobHistoryResourceOnUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.UserGroupJobHistoryResourceOnUnit"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserGroupAssigneeOnUnit": {
"type": "object",
"properties": {
"userGroupNo": {
"type": "string",
"nullable": true
},
"userGroupName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserGroupJobHistoryResourceOnUnit": {
"type": "object",
"properties": {
"userGroupNo": {
"type": "string",
"nullable": true
},
"userGroupName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserGroupResponsibleOnUnit": {
"type": "object",
"properties": {
"userGroupNo": {
"type": "string",
"nullable": true
},
"userGroupName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserGroupUnit": {
"type": "object",
"properties": {
"userGroupNo": {
"type": "string",
"nullable": true
},
"userGroupName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserGroupUser": {
"type": "object",
"properties": {
"userGroupNo": {
"type": "string",
"nullable": true
},
"userGroupName": {
"type": "string",
"nullable": true
},
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"access": {
"type": "boolean",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserGroupUserGroupLimitation": {
"type": "object",
"properties": {
"mainUserGroupNo": {
"type": "string",
"nullable": true
},
"mainUserGroupName": {
"type": "string",
"nullable": true
},
"referencedUserGroupNo": {
"type": "string",
"nullable": true
},
"referencedUserGroupName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserJobHistoryResourceOnUnit": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserResourceOnUnit": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserResponsibleOnUnit": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserRoleRelation": {
"type": "object",
"properties": {
"roleNo": {
"type": "string",
"nullable": true
},
"roleName": {
"type": "string",
"nullable": true
},
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserServicePrincipalMapping": {
"type": "object",
"properties": {
"userGuid": {
"type": "string",
"format": "uuid"
},
"tenantID": {
"type": "string",
"nullable": true
},
"clientID": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"lastUsed": {
"type": "string",
"format": "date-time"
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserUnit": {
"type": "object",
"properties": {
"userNo": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"inactiveUser": {
"type": "boolean"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"inactiveUnit": {
"type": "boolean"
},
"userTitle": {
"type": "string",
"nullable": true
},
"selectAtLogin": {
"type": "boolean"
},
"markAsReadRight": {
"type": "boolean"
},
"acknowledgeRight": {
"type": "boolean"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.UserManagement.UserUnitRoleLogin": {
"type": "object",
"properties": {
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"roleNo": {
"type": "string",
"nullable": true
},
"roleName": {
"type": "string",
"nullable": true
},
"lastLogin": {
"type": "string",
"format": "date-time",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.VAT.VAT": {
"type": "object",
"properties": {
"vatNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"rate": {
"type": "number",
"format": "double",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.ValidationResult": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean",
"readOnly": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ErrorReason"
},
"nullable": true,
"readOnly": true
},
"brokenRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.BrokenRule"
},
"nullable": true,
"readOnly": true
},
"subResults": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.VoyageReporting.VoyageData": {
"type": "object",
"properties": {
"voyageDataNo": {
"type": "string",
"nullable": true
},
"source": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageDataSource"
},
"voyageDataDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"positionLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"positionLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"recommendedTrimFromGreenSteam": {
"type": "number",
"format": "double",
"nullable": true
},
"operationalPerformanceGreenSteam": {
"type": "number",
"format": "double",
"nullable": true
},
"calculatedSpeedThroughWater": {
"type": "number",
"format": "double",
"nullable": true
},
"speedOverGround": {
"type": "number",
"format": "double",
"nullable": true
},
"courseOverGround": {
"type": "number",
"format": "double",
"nullable": true
},
"calculatedCurrentDirection": {
"type": "number",
"format": "double",
"nullable": true
},
"calculatedCurrentSpeed": {
"type": "number",
"format": "double",
"nullable": true
},
"draftForward": {
"type": "number",
"format": "double",
"nullable": true
},
"draftAft": {
"type": "number",
"format": "double",
"nullable": true
},
"propulsionPowerMeasuredViaTorqueMeters": {
"type": "number",
"format": "double",
"nullable": true
},
"calculatedPropulsionPower": {
"type": "number",
"format": "double",
"nullable": true
},
"trueWindForce": {
"type": "number",
"format": "double",
"nullable": true
},
"trueWindDirection": {
"type": "number",
"format": "double",
"nullable": true
},
"powerLostOnHullResistance": {
"type": "number",
"format": "double",
"nullable": true
},
"powerLostOnPropellerResistance": {
"type": "number",
"format": "double",
"nullable": true
},
"powerLostOnWindResistance": {
"type": "number",
"format": "double",
"nullable": true
},
"powerLostOnWaveResistance": {
"type": "number",
"format": "double",
"nullable": true
},
"powerLostOnWaterResistance": {
"type": "number",
"format": "double",
"nullable": true
},
"powerLostDueToLessThanOptimumTrim": {
"type": "number",
"format": "double",
"nullable": true
},
"depth": {
"type": "number",
"format": "double",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.VoyageReporting.VoyageReport": {
"type": "object",
"properties": {
"voyageReportNo": {
"type": "string",
"nullable": true
},
"voyageReportTypeNo": {
"type": "string",
"nullable": true
},
"voyageReportTypeName": {
"type": "string",
"nullable": true
},
"etaName": {
"type": "string",
"nullable": true
},
"etaReasonNo": {
"type": "string",
"nullable": true
},
"departurePortNo": {
"type": "string",
"nullable": true
},
"departurePortName": {
"type": "string",
"nullable": true
},
"departureTerminalNo": {
"type": "string",
"nullable": true
},
"departureTerminalName": {
"type": "string",
"nullable": true
},
"arrivalPortNo": {
"type": "string",
"nullable": true
},
"arrivalPortName": {
"type": "string",
"nullable": true
},
"arrivalTerminalNo": {
"type": "string",
"nullable": true
},
"arrivalTerminalName": {
"type": "string",
"nullable": true
},
"routeNo": {
"type": "string",
"nullable": true
},
"routeName": {
"type": "string",
"nullable": true
},
"lostFuelSavingReasonNo": {
"type": "string",
"nullable": true
},
"lostFuelSavingReasonName": {
"type": "string",
"nullable": true
},
"voyageReportUnitNo": {
"type": "string",
"nullable": true
},
"voyageReportUnitName": {
"type": "string",
"nullable": true
},
"offHireFrom": {
"type": "string",
"format": "date-time",
"nullable": true
},
"offHireTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUnitLoaded": {
"type": "string",
"format": "date-time",
"nullable": true
},
"departureDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startOfSeaPassage": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endOfSeaPassage": {
"type": "string",
"format": "date-time",
"nullable": true
},
"arrivalDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"firstUnitDischarge": {
"type": "string",
"format": "date-time",
"nullable": true
},
"noonTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eta": {
"type": "string",
"format": "date-time",
"nullable": true
},
"distanceDepartureStartOfSeaPassage": {
"type": "number",
"format": "double",
"nullable": true
},
"distanceStartOfSeaPassageEndOfSeaPassage": {
"type": "number",
"format": "double",
"nullable": true
},
"distanceArrivalEndOfSeaPassage": {
"type": "number",
"format": "double",
"nullable": true
},
"generalRemarks": {
"type": "string",
"nullable": true
},
"pilotDeparture": {
"type": "boolean",
"nullable": true
},
"pilotArrival": {
"type": "boolean",
"nullable": true
},
"tugsDeparture": {
"type": "integer",
"format": "int32",
"nullable": true
},
"tugsArrival": {
"type": "integer",
"format": "int32",
"nullable": true
},
"tugsInStandbyDeparture": {
"type": "integer",
"format": "int32",
"nullable": true
},
"tugsInStandbyArrival": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ballast": {
"type": "integer",
"format": "int32",
"nullable": true
},
"gMtActual": {
"type": "number",
"format": "double",
"nullable": true
},
"gMtMinimum": {
"type": "number",
"format": "double",
"nullable": true
},
"draftForward": {
"type": "number",
"format": "double",
"nullable": true
},
"draftAft": {
"type": "number",
"format": "double",
"nullable": true
},
"aux1DepartureKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"aux1ArrivalKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"aux2DepartureKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"aux2ArrivalKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"aux3DepartureKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"aux3ArrivalKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"aux4DepartureKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"aux4ArrivalKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sG1DepartureKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sG1ArrivalKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sG2DepartureKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sG2ArrivalKwH": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sludgeLanded": {
"type": "number",
"format": "double",
"nullable": true
},
"deadweightCalculated": {
"type": "integer",
"format": "int32",
"nullable": true
},
"fullCargoWeight": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cargoWeightCalculated": {
"type": "number",
"format": "double",
"nullable": true
},
"cargoWeightManual": {
"type": "number",
"format": "double",
"nullable": true
},
"consumptionKgNmCalculated": {
"type": "number",
"format": "double",
"nullable": true
},
"consumptionGGTNmCalculated": {
"type": "number",
"format": "double",
"nullable": true
},
"passengersCalculated": {
"type": "integer",
"format": "int32",
"nullable": true
},
"passengersManual": {
"type": "integer",
"format": "int32",
"nullable": true
},
"laneMetersNotUsedCalculated": {
"type": "number",
"format": "double",
"nullable": true
},
"laneMetersNotUsedManual": {
"type": "number",
"format": "double",
"nullable": true
},
"laneMetersUtilizationCalculated": {
"type": "number",
"format": "double",
"nullable": true
},
"averageSpeedForLast5Reports": {
"type": "number",
"format": "double",
"nullable": true
},
"averageBallastForLast5Reports": {
"type": "number",
"format": "double",
"nullable": true
},
"averagePreferredDepartureTrimForLast5Reports": {
"type": "number",
"format": "double",
"nullable": true
},
"preferredDepartureMeanDraft": {
"type": "number",
"format": "double",
"nullable": true
},
"preferredDepartureTrimCalculated": {
"type": "number",
"format": "double",
"nullable": true
},
"preferredDepartureTrimManual": {
"type": "number",
"format": "double",
"nullable": true
},
"preferredDepartureTrimDifference": {
"type": "number",
"format": "double",
"nullable": true
},
"windDirection": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2WindDirection"
},
"windForce": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2WindForce"
},
"positionLatitude": {
"type": "number",
"format": "double",
"nullable": true
},
"positionLongitude": {
"type": "number",
"format": "double",
"nullable": true
},
"seaState": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2SeaState"
},
"completed": {
"type": "boolean",
"nullable": true
},
"timeAtSea": {
"type": "number",
"format": "double",
"nullable": true
},
"timeInLoadingPort": {
"type": "number",
"format": "double",
"nullable": true
},
"averageSeaPassageSpeed": {
"type": "number",
"format": "double",
"nullable": true
},
"meConsumption": {
"type": "number",
"format": "double",
"nullable": true
},
"auxConsumption": {
"type": "number",
"format": "double",
"nullable": true
},
"boilerConsumption": {
"type": "number",
"format": "double",
"nullable": true
},
"offHireConsumption": {
"type": "number",
"format": "double",
"nullable": true
},
"consumptionKgNmMeAuxAndBoilerCalculated": {
"type": "number",
"format": "double",
"nullable": true
},
"gKwHAux": {
"type": "number",
"format": "double",
"nullable": true
},
"consumptionGGTNmMeAuxAndBoiler": {
"type": "number",
"format": "double",
"nullable": true
},
"averageSeaPassageSpeedBasedOnNoonTime": {
"type": "number",
"format": "double",
"nullable": true
},
"phoenixVoyageNumbers": {
"type": "string",
"nullable": true
},
"totalBunkerStockBeforeVoyage": {
"type": "number",
"format": "double",
"nullable": true
},
"excludeFromPerformanceMeasurements": {
"type": "boolean",
"nullable": true
},
"totalKWhConsumption": {
"type": "number",
"format": "double",
"nullable": true
},
"totalKWhConsumptionAtPort": {
"type": "number",
"format": "double",
"nullable": true
},
"greenSteamStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+GreenSteamStatus"
},
"measuredDeparture": {
"type": "string",
"format": "date-time",
"nullable": true
},
"measuredStartOfSeaPassage": {
"type": "string",
"format": "date-time",
"nullable": true
},
"measuredEndOfSeaPassage": {
"type": "string",
"format": "date-time",
"nullable": true
},
"measuredArrival": {
"type": "string",
"format": "date-time",
"nullable": true
},
"totalSailedDistance": {
"type": "number",
"format": "double",
"nullable": true
},
"departureDraftForward": {
"type": "number",
"format": "double",
"nullable": true
},
"departureDraftAft": {
"type": "number",
"format": "double",
"nullable": true
},
"averageDraft": {
"type": "number",
"format": "double",
"nullable": true
},
"averageOperationalPerformanceDuringSeaPassage": {
"type": "number",
"format": "double",
"nullable": true
},
"lostSavingDueToLessThanOptimumTrim": {
"type": "number",
"format": "double",
"nullable": true
},
"shorePowerConsumption": {
"type": "integer",
"format": "int32",
"nullable": true
},
"averageSeaPassageSpeedThroughWater": {
"type": "number",
"format": "double",
"nullable": true
},
"averagePowerConsumptionDuringSeaPassage": {
"type": "number",
"format": "double",
"nullable": true
},
"averageTrueWindForceInBeaufort": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2WindForce"
},
"averageTrueWindDirection": {
"type": "number",
"format": "double",
"nullable": true
},
"averageCalculatedEffectFromWind": {
"type": "number",
"format": "double",
"nullable": true
},
"totalCalculatedPropulsionEnergyConsumption": {
"type": "number",
"format": "double",
"nullable": true
},
"lostFuelSavingRemarks": {
"type": "string",
"nullable": true
},
"tugsDepartureReason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2TugsReason"
},
"tugsArrivalReason": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2TugsReason"
},
"securityLevel": {
"type": "integer",
"format": "int32"
},
"weightDiscrepancy": {
"type": "number",
"format": "double",
"nullable": true
},
"displacement": {
"type": "number",
"format": "double",
"nullable": true
},
"totalStockBeforeVoyageWithCorrection": {
"type": "number",
"format": "double",
"nullable": true
},
"propulsionKgNmWarning": {
"type": "boolean",
"nullable": true
},
"auxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportAuxItem"
},
"nullable": true
},
"meItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportMEItem"
},
"nullable": true
},
"offHireItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportOffHireItem"
},
"nullable": true
},
"boilerItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler"
},
"nullable": true
},
"cargoes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargo"
},
"nullable": true
},
"voyageDatas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageData"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.VoyageReporting.VoyageReportAuxItem": {
"type": "object",
"properties": {
"voyageReportNo": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"standardNo": {
"type": "string",
"nullable": true
},
"consumed": {
"type": "number",
"format": "double",
"nullable": true
},
"correction": {
"type": "number",
"format": "double",
"nullable": true
},
"currentStock": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"density": {
"type": "number",
"format": "double",
"nullable": true
},
"volume": {
"type": "number",
"format": "double",
"nullable": true
},
"temperature": {
"type": "number",
"format": "double",
"nullable": true
},
"corrected": {
"type": "boolean",
"nullable": true
},
"source": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2ConsumptionSources"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.VoyageReporting.VoyageReportCargo": {
"type": "object",
"properties": {
"requestedStowageZoneNo": {
"type": "string",
"nullable": true
},
"voyageReportNo": {
"type": "string",
"nullable": true
},
"imdgDist": {
"type": "integer",
"format": "int32",
"nullable": true
},
"stowOnBoard": {
"type": "string",
"nullable": true
},
"releaseNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"phoenixVoyageNo": {
"type": "string",
"nullable": true
},
"cargoTypeNo": {
"type": "string",
"nullable": true
},
"unitNumber": {
"type": "string",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"nullable": true
},
"satlot": {
"type": "boolean",
"nullable": true
},
"length": {
"type": "number",
"format": "double",
"nullable": true
},
"setp1": {
"type": "number",
"format": "double",
"nullable": true
},
"setp2": {
"type": "number",
"format": "double",
"nullable": true
},
"imoClasses": {
"type": "string",
"nullable": true
},
"passengers": {
"type": "integer",
"format": "int32",
"nullable": true
},
"pluggedIn": {
"type": "boolean",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.StationDescription"
},
"additionalCargo": {
"type": "boolean",
"nullable": true
},
"cargoDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.VoyageReporting.VoyageReportCargoDetail"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.VoyageReporting.VoyageReportCargoDetail": {
"type": "object",
"properties": {
"portCallCargoGuid": {
"type": "string",
"format": "uuid"
},
"portCallCargoReleaseNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"technicalName": {
"type": "string",
"nullable": true
},
"emsNo": {
"type": "string",
"nullable": true
},
"flashPoint": {
"type": "string",
"nullable": true
},
"imoClass": {
"type": "string",
"nullable": true
},
"imoSubClass": {
"type": "string",
"nullable": true
},
"limitedQuantity": {
"type": "boolean",
"nullable": true
},
"marinePolutant": {
"type": "boolean",
"nullable": true
},
"packingGroup": {
"type": "string",
"nullable": true
},
"stCat": {
"type": "string",
"nullable": true
},
"unNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"noPkgs": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isBulk": {
"type": "boolean",
"nullable": true
},
"isResidues": {
"type": "boolean",
"nullable": true
},
"packageType": {
"type": "string",
"nullable": true
},
"productName": {
"type": "string",
"nullable": true
},
"netWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"grossWeight": {
"type": "number",
"format": "double",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.VoyageReporting.VoyageReportItemBoiler": {
"type": "object",
"properties": {
"voyageReportNo": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"standardNo": {
"type": "string",
"nullable": true
},
"consumed": {
"type": "number",
"format": "double",
"nullable": true
},
"correction": {
"type": "number",
"format": "double",
"nullable": true
},
"currentStock": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"density": {
"type": "number",
"format": "double",
"nullable": true
},
"volume": {
"type": "number",
"format": "double",
"nullable": true
},
"temperature": {
"type": "number",
"format": "double",
"nullable": true
},
"corrected": {
"type": "boolean",
"nullable": true
},
"source": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2ConsumptionSources"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.VoyageReporting.VoyageReportMEItem": {
"type": "object",
"properties": {
"voyageReportNo": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"standardNo": {
"type": "string",
"nullable": true
},
"consumed": {
"type": "number",
"format": "double",
"nullable": true
},
"correction": {
"type": "number",
"format": "double",
"nullable": true
},
"currentStock": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"density": {
"type": "number",
"format": "double",
"nullable": true
},
"volume": {
"type": "number",
"format": "double",
"nullable": true
},
"temperature": {
"type": "number",
"format": "double",
"nullable": true
},
"corrected": {
"type": "boolean",
"nullable": true
},
"source": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2ConsumptionSources"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.VoyageReporting.VoyageReportOffHireItem": {
"type": "object",
"properties": {
"voyageReportNo": {
"type": "string",
"nullable": true
},
"itemNo": {
"type": "string",
"nullable": true
},
"itemName": {
"type": "string",
"nullable": true
},
"standardNo": {
"type": "string",
"nullable": true
},
"consumed": {
"type": "number",
"format": "double",
"nullable": true
},
"correction": {
"type": "number",
"format": "double",
"nullable": true
},
"currentStock": {
"type": "number",
"format": "double",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"density": {
"type": "number",
"format": "double",
"nullable": true
},
"volume": {
"type": "number",
"format": "double",
"nullable": true
},
"temperature": {
"type": "number",
"format": "double",
"nullable": true
},
"corrected": {
"type": "boolean",
"nullable": true
},
"source": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+VoyageReport2ConsumptionSources"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebDashboard.WebDashboard": {
"type": "object",
"properties": {
"webDashboardNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"ownerUserNo": {
"type": "string",
"nullable": true
},
"ownerUserName": {
"type": "string",
"nullable": true
},
"hasAvailablePages": {
"type": "boolean"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sharedWith": {
"type": "string",
"nullable": true
},
"webDashboardPages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage"
},
"nullable": true
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardCombinedUserRole"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebDashboard.WebDashboardCombinedUserRole": {
"type": "object",
"properties": {
"webDashboardNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebDashboard.WebDashboardContent": {
"type": "object",
"properties": {
"webDashboardContentNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"ownerUserNo": {
"type": "string",
"nullable": true
},
"ownerUserName": {
"type": "string",
"nullable": true
},
"contentType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebDashboardContentType"
},
"dimensions": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebDashboardContentDimension"
},
"analyticsReportNo": {
"type": "string",
"nullable": true
},
"analyticsReportDescription": {
"type": "string",
"nullable": true
},
"numberSource": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebDashboardNumberSource"
},
"excelFieldName": {
"type": "string",
"nullable": true
},
"analyticsReportOutputFieldGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"numberCalculation": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DynamicDashboardNumberCalculation"
},
"allowDrillDown": {
"type": "boolean",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"webLink": {
"type": "string",
"nullable": true
},
"graphSettings": {
"nullable": true
},
"componentMapNo": {
"type": "string",
"nullable": true
},
"componentMapName": {
"type": "string",
"nullable": true
},
"dateFilterField": {
"type": "string",
"format": "uuid",
"nullable": true
},
"objectIdFilterField": {
"type": "string",
"format": "uuid",
"nullable": true
},
"powerBIGroupId": {
"type": "string",
"nullable": true
},
"powerBIReportId": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebDashboard.WebDashboardPage": {
"type": "object",
"properties": {
"webDashboardPageNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"ownerUserNo": {
"type": "string",
"nullable": true
},
"ownerUserName": {
"type": "string",
"nullable": true
},
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageUnit"
},
"nullable": true
},
"webDashboardContents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageWebDashboardContent"
},
"nullable": true
},
"sharedLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageSharedLink"
},
"nullable": true
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebDashboard.WebDashboardPageFilter"
},
"nullable": true
},
"backgroundDocumentNo": {
"type": "string",
"nullable": true
},
"backgroundDocumentName": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebDashboard.WebDashboardPageAccessToken": {
"type": "object",
"properties": {
"webDashboardPageNo": {
"type": "string",
"nullable": true
},
"accessToken": {
"type": "string",
"nullable": true
},
"expiresIn": {
"type": "integer",
"format": "int32"
},
"refreshRate": {
"type": "integer",
"format": "int32"
},
"pageOwnerLanguageNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebDashboard.WebDashboardPageFilter": {
"type": "object",
"properties": {
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webDashboardPageGuid": {
"type": "string",
"format": "uuid"
},
"webDashboardPageNo": {
"type": "string",
"nullable": true
},
"filterName": {
"type": "string",
"nullable": true
},
"dataType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebDashboardPageFilterType"
},
"fieldsToFilter": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"enableSelectionFromList": {
"type": "boolean",
"nullable": true
},
"analyticsReportNo": {
"type": "string",
"nullable": true
},
"analyticsReportDescription": {
"type": "string",
"nullable": true
},
"analyticsReportOutputFieldGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebDashboard.WebDashboardPageSharedLink": {
"type": "object",
"properties": {
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webDashboardPageGuid": {
"type": "string",
"format": "uuid"
},
"webDashboardPageNo": {
"type": "string",
"nullable": true
},
"linkKey": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastUsedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebDashboard.WebDashboardPageUnit": {
"type": "object",
"properties": {
"webDashboardPageNo": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebDashboard.WebDashboardPageWebDashboardContent": {
"type": "object",
"properties": {
"webDashboardPageNo": {
"type": "string",
"nullable": true
},
"webDashboardContentNo": {
"type": "string",
"nullable": true
},
"webDashboardContentName": {
"type": "string",
"nullable": true
},
"contentType": {
"type": "string",
"nullable": true
},
"layout": {
"type": "string",
"nullable": true
},
"analyticsReportNo": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebDashboard.WebDashboardWebDashboardPage": {
"type": "object",
"properties": {
"webDashboardNo": {
"type": "string",
"nullable": true
},
"webDashboardName": {
"type": "string",
"nullable": true
},
"webDashboardPageNo": {
"type": "string",
"nullable": true
},
"webDashboardPageName": {
"type": "string",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ownerUserNo": {
"type": "string",
"nullable": true
},
"ownerUserName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebTaskList.WebTaskListConfiguration": {
"type": "object",
"properties": {
"tasklistConfigurationName": {
"type": "string",
"nullable": true
},
"configuration": {
"nullable": true
},
"userGuid": {
"type": "string",
"format": "uuid"
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.ExecuteVesselReportWebhookResult": {
"type": "object",
"properties": {
"vesselReportNo": {
"type": "string",
"nullable": true
},
"webhookNo": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"success": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.InstanceSplit": {
"type": "object",
"properties": {
"reportNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"newInstanceNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.Position": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReport": {
"type": "object",
"properties": {
"vesselReportNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeName": {
"type": "string",
"nullable": true
},
"vesselReportTypeRevisionCacheNo": {
"type": "string",
"nullable": true
},
"reportDateUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reportDateUtcOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"reportDateLocal": {
"type": "string",
"format": "date-time",
"nullable": true
},
"properties": {
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"approvalStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportApprovalStatus"
},
"approvalFlow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportApprovalFlow"
},
"vesselReportSequenceInstanceNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeGroupNo": {
"type": "string",
"nullable": true
},
"isLatestOfGroup": {
"type": "boolean"
},
"webhookLogStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebhookLogStatus"
},
"vesselReportSequenceNo": {
"type": "string",
"nullable": true
},
"imoNo": {
"type": "string",
"nullable": true
},
"isStartReport": {
"type": "boolean"
},
"imported": {
"type": "boolean",
"nullable": true
},
"canApprove": {
"type": "boolean"
},
"createSequenceNo": {
"type": "string",
"nullable": true
},
"addToSequenceInstanceNo": {
"type": "string",
"nullable": true
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportApprover"
},
"nullable": true
},
"confidentialities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportConfidentiality"
},
"nullable": true
},
"consumptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportConsumption"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportActions": {
"type": "object",
"properties": {
"allowApproveVesselReport": {
"type": "boolean"
},
"allowRejectVesselReport": {
"type": "boolean"
},
"allowRequestApproval": {
"type": "boolean"
},
"allowFillOutVesselReport": {
"type": "boolean"
},
"allowReopenVesselReport": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportApprover": {
"type": "object",
"properties": {
"vesselReportNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"approvalOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"approvalStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportApprovalStatus"
},
"addedBy": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportApproverAddedBy"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"keys": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeKeys"
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeType"
},
"unitNo": {
"type": "string",
"nullable": true
},
"hasChildren": {
"type": "boolean"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNode"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeKeys": {
"type": "object",
"properties": {
"vesselReportTypeKey": {
"type": "string",
"nullable": true
},
"yearKey": {
"type": "string",
"nullable": true
},
"monthKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBrowserNodeType": {
"enum": [
"Root",
"VesselReportType",
"Year",
"Month",
"None"
],
"type": "string"
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBuildRequest": {
"type": "object",
"properties": {
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"vesselReportSequenceInstanceNo": {
"type": "string",
"nullable": true
},
"reportDateUtc": {
"type": "string",
"format": "date-time"
},
"reportDateUtcOffset": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportBuildResult": {
"type": "object",
"properties": {
"report": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
},
"apiScriptValidationResult": {
"$ref": "#/components/schemas/SerticaWebApi.Models.ValidationResult"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportConfidentiality": {
"type": "object",
"properties": {
"vesselReportNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportConsumption": {
"type": "object",
"properties": {
"mainVesselReportNo": {
"type": "string",
"nullable": true
},
"referencedVesselReportNo": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double"
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode": {
"type": "object",
"properties": {
"no": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"startVesselReportTypeNo": {
"type": "string",
"nullable": true
},
"nodeType": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNodeType"
},
"hasChildren": {
"type": "boolean"
},
"fillOutByOrder": {
"type": "boolean"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNode"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportCreateNodeType": {
"enum": [
"Root",
"Sequence",
"SequenceInstance",
"Report",
"ReportType",
"SequencesAndReportTypes",
"ActiveSequences"
],
"type": "string"
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate": {
"type": "object",
"properties": {
"vesselReportFieldListTemplateNo": {
"type": "string",
"nullable": true
},
"vesselReportFieldListTemplateName": {
"type": "string",
"nullable": true
},
"revision": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListValue"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplateRevisionCache": {
"type": "object",
"properties": {
"vesselReportFieldListTemplateRevisionCacheNo": {
"type": "string",
"nullable": true
},
"vesselReportFieldListTemplateNo": {
"type": "string",
"nullable": true
},
"vesselReportFieldListTemplateName": {
"type": "string",
"nullable": true
},
"revision": {
"type": "string",
"nullable": true
},
"templateValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListValue"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListValue": {
"type": "object",
"properties": {
"valueText": {
"type": "string",
"nullable": true
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"vesselReportFieldListTemplateNo": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportRejectReason": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"recipient": {
"$ref": "#/components/schemas/SerticaWebApi.Models.UserManagement.CombinedUserRole2"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportResponse": {
"type": "object",
"properties": {
"vesselReportNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScript": {
"type": "object",
"properties": {
"debug": {
"type": "boolean"
},
"report": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReport"
},
"layout": {
"type": "string",
"nullable": true
},
"script": {
"type": "string",
"nullable": true
},
"definitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeFieldDefinition"
},
"nullable": true
},
"tables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
},
"nullable": true
},
"type": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScriptType"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScriptNode": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"autoCompleteString": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScriptNodeType"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScriptNode"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScriptNodeType": {
"enum": [
"None",
"Property",
"Method",
"Object"
],
"type": "string"
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportScriptType": {
"enum": [
"Field",
"Column"
],
"type": "string"
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequence": {
"type": "object",
"properties": {
"vesselReportSequenceNo": {
"type": "string",
"nullable": true
},
"vesselReportSequenceName": {
"type": "string",
"nullable": true
},
"fillOutByOrder": {
"type": "boolean",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"startVesselReportTypeNo": {
"type": "string",
"nullable": true
},
"startVesselReportTypeName": {
"type": "string",
"nullable": true
},
"endVesselReportTypeNo": {
"type": "string",
"nullable": true
},
"endVesselReportTypeName": {
"type": "string",
"nullable": true
},
"vesselTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceVesselType"
},
"nullable": true
},
"vesselReportTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceVesselReportType"
},
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstance": {
"type": "object",
"properties": {
"vesselReportSequenceInstanceNo": {
"type": "string",
"nullable": true
},
"startReportNo": {
"type": "string",
"nullable": true
},
"endReportNo": {
"type": "string",
"nullable": true
},
"startReportTypeNo": {
"type": "string",
"nullable": true
},
"startReportTypeName": {
"type": "string",
"nullable": true
},
"endReportTypeNo": {
"type": "string",
"nullable": true
},
"endReportTypeName": {
"type": "string",
"nullable": true
},
"sequenceNo": {
"type": "string",
"nullable": true
},
"sequenceName": {
"type": "string",
"nullable": true
},
"startReportDateUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endReportDateUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"middleReports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceVesselReport"
},
"nullable": true
},
"middleReportTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceVesselReportType"
},
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceMerge": {
"type": "object",
"properties": {
"sequenceInstanceNos": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceSplit": {
"type": "object",
"properties": {
"sequenceNo": {
"type": "string",
"nullable": true
},
"sequenceInstanceNo": {
"type": "string",
"nullable": true
},
"instanceSplits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.InstanceSplit"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceVesselReport": {
"type": "object",
"properties": {
"vesselReportSequenceInstanceGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"vesselReportNo": {
"type": "string",
"nullable": true
},
"vesselReportSequenceInstanceNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeName": {
"type": "string",
"nullable": true
},
"reportDateUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reportDateUtcOffset": {
"type": "integer",
"format": "int32",
"nullable": true
},
"unitNo": {
"type": "string",
"nullable": true
},
"unitName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceInstanceVesselReportType": {
"type": "object",
"properties": {
"vesselReportSequenceInstanceGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeName": {
"type": "string",
"nullable": true
},
"vesselReportSequenceInstanceNo": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceVesselReportType": {
"type": "object",
"properties": {
"vesselReportSequenceGuid": {
"type": "string",
"format": "uuid"
},
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeName": {
"type": "string",
"nullable": true
},
"vesselReportSequenceNo": {
"type": "string",
"nullable": true
},
"vesselReportSequenceName": {
"type": "string",
"nullable": true
},
"order": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportSequenceVesselType": {
"type": "object",
"properties": {
"vesselReportSequenceGuid": {
"type": "string",
"format": "uuid"
},
"vesselTypeNo": {
"type": "string",
"nullable": true
},
"vesselTypeName": {
"type": "string",
"nullable": true
},
"vesselReportSequenceNo": {
"type": "string",
"nullable": true
},
"vesselReportSequenceName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable": {
"type": "object",
"properties": {
"vesselReportTableNo": {
"type": "string",
"nullable": true
},
"vesselReportTableName": {
"type": "string",
"nullable": true
},
"allowDeleteRows": {
"type": "boolean",
"nullable": true
},
"allowSorting": {
"type": "boolean",
"nullable": true
},
"allowNewRows": {
"type": "boolean",
"nullable": true
},
"revision": {
"type": "string",
"nullable": true
},
"predefinedRows": {
"type": "string",
"nullable": true
},
"columns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableColumn"
},
"nullable": true
},
"consumptionMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableConsumptionMapping"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableColumn": {
"type": "object",
"properties": {
"columnId": {
"type": "string",
"nullable": true
},
"dataType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTableColumnDataType"
},
"dateFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DateTimeFormats"
},
"defaultValue": {
"type": "string",
"nullable": true
},
"index": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mandatory": {
"type": "boolean",
"nullable": true
},
"multiline": {
"type": "boolean",
"nullable": true
},
"numberOfDecimals": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberMaxValue": {
"type": "number",
"format": "double",
"nullable": true
},
"numberMinValue": {
"type": "number",
"format": "double",
"nullable": true
},
"readOnly": {
"type": "boolean",
"nullable": true
},
"referenceType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTableColumnReference"
},
"skipThousandsSeparator": {
"type": "boolean",
"nullable": true
},
"suffix": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"width": {
"type": "integer",
"format": "int32",
"nullable": true
},
"vesselReportFieldListTemplateNo": {
"type": "string",
"nullable": true
},
"vesselReportFieldListTemplateRevisionCacheNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeNoNameFilterGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"vesselReportTypeNoNameFilterNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeNoNameFilterName": {
"type": "string",
"nullable": true
},
"calculationScript": {
"type": "string",
"nullable": true
},
"validationScript": {
"type": "string",
"nullable": true
},
"executionOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableConsumptionMapping": {
"type": "object",
"properties": {
"vesselReportTableNo": {
"type": "string",
"nullable": true
},
"vesselReportColumnId": {
"type": "string",
"nullable": true
},
"vesselReportColumnTitle": {
"type": "string",
"nullable": true
},
"quantityColumnId": {
"type": "string",
"nullable": true
},
"quantityColumnTitle": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableRevisionCache": {
"type": "object",
"properties": {
"vesselReportTableRevisionCacheNo": {
"type": "string",
"nullable": true
},
"vesselReportTableGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"allowDeleteRows": {
"type": "boolean",
"nullable": true
},
"allowSorting": {
"type": "boolean",
"nullable": true
},
"allowNewRows": {
"type": "boolean",
"nullable": true
},
"revision": {
"type": "string",
"nullable": true
},
"predefinedRows": {
"type": "string",
"nullable": true
},
"vesselReportTableNo": {
"type": "string",
"nullable": true
},
"vesselReportTableName": {
"type": "string",
"nullable": true
},
"columns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableColumn"
},
"nullable": true
},
"consumptionMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTableConsumptionMapping"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType": {
"type": "object",
"properties": {
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeName": {
"type": "string",
"nullable": true
},
"partOfSequence": {
"type": "boolean",
"nullable": true
},
"inactive": {
"type": "boolean",
"nullable": true
},
"layout": {
"type": "string",
"nullable": true
},
"approvalFlow": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportApprovalFlow"
},
"revision": {
"type": "string",
"nullable": true
},
"vesselReportTypeGroupNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeGroupName": {
"type": "string",
"nullable": true
},
"vesselTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeVesselType"
},
"nullable": true
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeApprover"
},
"nullable": true
},
"confidentialities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality"
},
"nullable": true
},
"fieldDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeFieldDefinition"
},
"nullable": true
},
"analyticsCustomTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeAnalyticsCustomTemplate"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeAnalyticsCustomTemplate": {
"type": "object",
"properties": {
"vesselReportTypeGuid": {
"type": "string",
"format": "uuid"
},
"analyticsCustomTemplateNo": {
"type": "string",
"nullable": true
},
"analyticsCustomTemplateName": {
"type": "string",
"nullable": true
},
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeName": {
"type": "string",
"nullable": true
},
"revision": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeApprover": {
"type": "object",
"properties": {
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"approvalOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeConfidentiality": {
"type": "object",
"properties": {
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeExportResult": {
"type": "object",
"properties": {
"reportTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportType"
},
"nullable": true
},
"fieldListTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportFieldListTemplate"
},
"nullable": true
},
"reportTables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTable"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeFieldDefinition": {
"type": "object",
"properties": {
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeName": {
"type": "string",
"nullable": true
},
"calculationScript": {
"type": "string",
"nullable": true
},
"defaultValue": {
"type": "string",
"nullable": true
},
"mandatory": {
"type": "boolean",
"nullable": true
},
"maxDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"maxDecimalValue": {
"type": "number",
"format": "double",
"nullable": true
},
"maxIntValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"maxLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"minDecimalValue": {
"type": "number",
"format": "double",
"nullable": true
},
"minIntValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"minLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"readOnly": {
"type": "boolean",
"nullable": true
},
"numberOfDecimals": {
"type": "integer",
"format": "int32",
"nullable": true
},
"skipThousandsSeparator": {
"type": "boolean",
"nullable": true
},
"showAsSearch": {
"type": "boolean",
"nullable": true
},
"useDateTimeOffset": {
"type": "boolean",
"nullable": true
},
"tag": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"tooltip": {
"type": "string",
"nullable": true
},
"validationScript": {
"type": "string",
"nullable": true
},
"definitionId": {
"type": "string",
"nullable": true
},
"referenceType": {
"type": "string",
"nullable": true
},
"secondaryTitle": {
"type": "string",
"nullable": true
},
"fontColor": {
"type": "string",
"nullable": true
},
"numberSuffix": {
"type": "string",
"nullable": true
},
"executionOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"enableAis": {
"type": "boolean",
"nullable": true
},
"multiline": {
"type": "boolean",
"nullable": true
},
"dataType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.WebVesselReportingSystem.VesselReportTypeFieldDataType"
},
"vesselReportFieldListTemplateNo": {
"type": "string",
"nullable": true
},
"vesselReportFieldListTemplateName": {
"type": "string",
"nullable": true
},
"vesselReportFieldListTemplateRevisionCacheNo": {
"type": "string",
"nullable": true
},
"vrsApiScriptNo": {
"type": "string",
"nullable": true
},
"vrsApiScriptName": {
"type": "string",
"nullable": true
},
"vesselReportTypeNoNameFilterGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"vesselReportTypeNoNameFilterNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeNoNameFilterName": {
"type": "string",
"nullable": true
},
"vesselReportTableNo": {
"type": "string",
"nullable": true
},
"vesselReportTableName": {
"type": "string",
"nullable": true
},
"vesselReportTableRevisionCacheNo": {
"type": "string",
"nullable": true
},
"tableHeight": {
"type": "integer",
"format": "int32",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroup": {
"type": "object",
"properties": {
"vesselReportTypeGroupNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeGroupName": {
"type": "string",
"nullable": true
},
"combinedUserRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroupCombinedUserRole"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroupAllowedActions": {
"type": "object",
"properties": {
"vesselReportTypeGroupNo": {
"type": "string",
"nullable": true
},
"canCreate": {
"type": "boolean"
},
"canUpdate": {
"type": "boolean"
},
"canDelete": {
"type": "boolean"
},
"canReopen": {
"type": "boolean"
},
"canReopenLatest": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeGroupCombinedUserRole": {
"type": "object",
"properties": {
"vesselReportTypeGroupNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleNo": {
"type": "string",
"nullable": true
},
"combinedUserRoleName": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.CombinedUserRole2Type"
},
"canCreate": {
"type": "boolean"
},
"canUpdate": {
"type": "boolean"
},
"canDelete": {
"type": "boolean"
},
"canReopen": {
"type": "boolean"
},
"canReopenLatest": {
"type": "boolean"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeRevisionCache": {
"type": "object",
"properties": {
"vesselReportTypeRevisionCacheNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeGuid": {
"type": "string",
"nullable": true
},
"layout": {
"type": "string",
"nullable": true
},
"revision": {
"type": "string",
"nullable": true
},
"fieldDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeFieldDefinition"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VesselReportTypeVesselType": {
"type": "object",
"properties": {
"vesselReportTypeGuid": {
"type": "string",
"format": "uuid"
},
"vesselTypeNo": {
"type": "string",
"nullable": true
},
"vesselTypeName": {
"type": "string",
"nullable": true
},
"vesselReportTypeNo": {
"type": "string",
"nullable": true
},
"vesselReportTypeName": {
"type": "string",
"nullable": true
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VrsApiConfiguration": {
"type": "object",
"properties": {
"no": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"apiKey": {
"type": "string",
"nullable": true
},
"baseUrl": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"hasPassword": {
"type": "boolean",
"nullable": true
},
"hasApiKey": {
"type": "boolean",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.WebVesselReportingSystem.VrsApiScript": {
"type": "object",
"properties": {
"no": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"script": {
"type": "string",
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Webhooks.ApiWebhookExecuteResult": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
},
"webhookNo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Webhooks.Webhook": {
"type": "object",
"properties": {
"webhookNo": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"dataObject": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataObject"
},
"webhookStatus": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebhookStatus"
},
"apiKey": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"script": {
"type": "string",
"nullable": true
},
"filterScript": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookDocument"
},
"nullable": true
},
"webhookLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
},
"nullable": true
},
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookResponse"
},
"nullable": true
},
"webhookSchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookSchedule"
},
"nullable": true
},
"apIs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookApi"
},
"nullable": true
},
"updateUserNo": {
"type": "string",
"nullable": true
},
"updateUserName": {
"type": "string",
"nullable": true
},
"updateDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Webhooks.WebhookApi": {
"type": "object",
"properties": {
"webhookNo": {
"type": "string",
"nullable": true
},
"apiNo": {
"type": "string",
"nullable": true
},
"apiUrl": {
"type": "string",
"nullable": true
},
"authenticationType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+AuthenticationType"
},
"userName": {
"type": "string",
"nullable": true
},
"passwordPlainText": {
"type": "string",
"nullable": true
},
"apiKeyPlainText": {
"type": "string",
"nullable": true
},
"hasPassword": {
"type": "boolean",
"nullable": true
},
"hasApiKey": {
"type": "boolean",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Webhooks.WebhookDocument": {
"type": "object",
"properties": {
"webhookNo": {
"type": "string",
"nullable": true
},
"documentNo": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"pageNo": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentTypeNo": {
"type": "string",
"nullable": true
},
"documentTypeName": {
"type": "string",
"nullable": true
},
"documentTypeUnitNo": {
"type": "string",
"nullable": true
},
"documentGroupName": {
"type": "string",
"nullable": true
},
"documentGroupNo": {
"type": "string",
"nullable": true
},
"documentGroupUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitNo": {
"type": "string",
"nullable": true
},
"documentUnitName": {
"type": "string",
"nullable": true
},
"documentDataOwner": {
"$ref": "#/components/schemas/Logimatic.BaseClasses30.DataOwner"
},
"previewFormat": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat"
},
"guidForReferencedObject": {
"type": "string",
"format": "uuid",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Webhooks.WebhookLog": {
"type": "object",
"properties": {
"idSeq": {
"type": "integer",
"format": "int32"
},
"startTimeStampUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endTimeStampUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"duration": {
"type": "integer",
"format": "int32",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"request": {
"nullable": true
},
"retransmitted": {
"type": "boolean",
"nullable": true
},
"additionalData": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+WebhookLogStatus"
},
"dataObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webhookEvent": {
"type": "string",
"nullable": true
},
"dataObjectType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataObject"
},
"webhookGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webhookNo": {
"type": "string",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Webhooks.WebhookResponse": {
"type": "object",
"properties": {
"webhookGuid": {
"type": "string",
"format": "uuid"
},
"webhookNo": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createRoleNo": {
"type": "string",
"nullable": true
},
"createUserNo": {
"type": "string",
"nullable": true
},
"createUserName": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Webhooks.WebhookRunScriptResult": {
"type": "object",
"properties": {
"executeWebhook": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
},
"output": {
"type": "string",
"nullable": true
},
"consoleLog": {
"type": "string",
"nullable": true
},
"webhookLog": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookLog"
},
"scriptExecutionFinishedWithoutErrors": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Webhooks.WebhookSchedule": {
"type": "object",
"properties": {
"webhookNo": {
"type": "string",
"nullable": true
},
"frequency": {
"type": "integer",
"format": "int32",
"nullable": true
},
"frequencyUnit": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+FrequencyType"
},
"firstScheduledRun": {
"type": "string",
"format": "date-time",
"nullable": true
},
"guid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"liveObjectGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"unitGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"deleted": {
"type": "boolean"
},
"latestHistoryGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Link"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Webhooks.WebhookScriptNode": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"autoCompleteString": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookScriptNodeType"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SerticaWebApi.Models.Webhooks.WebhookScriptNode"
},
"nullable": true
}
},
"additionalProperties": false
},
"SerticaWebApi.Models.Webhooks.WebhookScriptNodeType": {
"enum": [
"None",
"Property",
"Method",
"Object"
],
"type": "string"
},
"SerticaWebApi.Models.Webhooks.WebhookScriptValidation": {
"type": "object",
"properties": {
"webhookNo": {
"type": "string",
"nullable": true
},
"webhookType": {
"$ref": "#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.SystemData+DataObject"
},
"sendRequest": {
"type": "boolean"
},
"dataObjectNo": {
"type": "string",
"nullable": true
},
"dataObjectUnitGuid": {
"type": "string",
"nullable": true
},
"script": {
"type": "string",
"nullable": true
},
"filterScript": {
"type": "string",
"nullable": true
},
"isFilterScript": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SerticaWebApi.Updating.WebVesselReportingSystem.VesselReportScriptObjectType": {
"enum": [
"None",
"Utility",
"Calculation",
"Validation",
"Api",
"Table"
],
"type": "string"
},
"System.Collections.Generic.KeyValuePair`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"System.IO.File": {
"type": "object",
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "http",
"description": "JWT Authorization header using the Bearer scheme",
"scheme": "bearer"
}
}
},
"tags": [
{
"name": "AccountingDimensions"
},
{
"name": "AccountingDimensionsCache"
},
{
"name": "Accounts"
},
{
"name": "ActivityGroups"
},
{
"name": "AddressCategories"
},
{
"name": "AddressClassifications"
},
{
"name": "Addresses"
},
{
"name": "AiClient"
},
{
"name": "Analytics"
},
{
"name": "AnalyticsCustomMenus"
},
{
"name": "AnalyticsCustomTemplates"
},
{
"name": "AnalyticsExcelTemplates"
},
{
"name": "AnalyticsReports"
},
{
"name": "AnalyticsResources"
},
{
"name": "AnalyticsSubscriptions"
},
{
"name": "AnalyticsTemplateUserRights"
},
{
"name": "AnalyticsUserMenus"
},
{
"name": "ApprovalSetups"
},
{
"name": "ApprovalWebExcludedUnits"
},
{
"name": "Auth"
},
{
"name": "AvailableGridLayouts"
},
{
"name": "AvailableJobListWebSearch"
},
{
"name": "BrbOperations"
},
{
"name": "BrbReceivers"
},
{
"name": "BudgetAccrualExports"
},
{
"name": "Budgets"
},
{
"name": "CalculatePurchaseOrder"
},
{
"name": "Carriers"
},
{
"name": "CertificateDocuments"
},
{
"name": "CertificateGroupRules"
},
{
"name": "CertificateGroups"
},
{
"name": "CertificateLocations"
},
{
"name": "CertificateNotificationSettings"
},
{
"name": "Certificates"
},
{
"name": "CertificateTree"
},
{
"name": "ChangeRequestCriticalities"
},
{
"name": "ChangeRequestDocuments"
},
{
"name": "ChangeRequestSources"
},
{
"name": "ClassCodes"
},
{
"name": "ClassSocieties"
},
{
"name": "CombinedUserRoles"
},
{
"name": "CommunicationLanguages"
},
{
"name": "Companies"
},
{
"name": "ComponentLocations"
},
{
"name": "ComponentMaps"
},
{
"name": "ComponentPhotos"
},
{
"name": "Components"
},
{
"name": "ComponentTypes"
},
{
"name": "ControlledCopies"
},
{
"name": "ControlledCopyRevisionDocuments"
},
{
"name": "Counters"
},
{
"name": "CounterTypes"
},
{
"name": "CountryCodes"
},
{
"name": "Currencies"
},
{
"name": "DataTransactions"
},
{
"name": "DataWarehouseAnalyticsTemplates"
},
{
"name": "DataWarehouseConnections"
},
{
"name": "DeliveryConditions"
},
{
"name": "DeliveryCosts"
},
{
"name": "Departments"
},
{
"name": "Destinations"
},
{
"name": "Device"
},
{
"name": "DocumentClasses"
},
{
"name": "DocumentGroups"
},
{
"name": "DocumentMailTemplates"
},
{
"name": "Documents"
},
{
"name": "DocumentTransactions"
},
{
"name": "DocumentTree"
},
{
"name": "DocumentTypes"
},
{
"name": "DocumentWeblinks"
},
{
"name": "ElectronicLogbook"
},
{
"name": "Embarkations"
},
{
"name": "EnvironmentalItems"
},
{
"name": "Equipments"
},
{
"name": "EvaluationAnswers"
},
{
"name": "EvaluationQuestionObjectLinks"
},
{
"name": "EvaluationQuestions"
},
{
"name": "EventReports"
},
{
"name": "ExcelImport"
},
{
"name": "ExpectedFaults"
},
{
"name": "ExternalCalendars"
},
{
"name": "ExternalItems"
},
{
"name": "FinancialFollowupNodeResponses"
},
{
"name": "Flags"
},
{
"name": "FormBrowser"
},
{
"name": "FormDocuments"
},
{
"name": "Forms"
},
{
"name": "FormsSignature"
},
{
"name": "FormTemplateDocuments"
},
{
"name": "FormTemplateHelpImageDocuments"
},
{
"name": "FormTemplates"
},
{
"name": "FormTemplateTables"
},
{
"name": "FuelTypes"
},
{
"name": "FunctionAreas"
},
{
"name": "GarbageReceivers"
},
{
"name": "GrbOperations"
},
{
"name": "GridColumnLayouts"
},
{
"name": "GridLayouts"
},
{
"name": "GroupCodes"
},
{
"name": "ImInvoices"
},
{
"name": "InspectionAreas"
},
{
"name": "InspectionJobHistories"
},
{
"name": "InspectionJobs"
},
{
"name": "InspectionLists"
},
{
"name": "InspectionListTypes"
},
{
"name": "InvoiceDocuments"
},
{
"name": "IosDataSync"
},
{
"name": "ItemGroups"
},
{
"name": "ItemGroupSelection"
},
{
"name": "ItemGroupSelectionTree"
},
{
"name": "ItemLocations"
},
{
"name": "ItemLocationTree"
},
{
"name": "ItemPhotos"
},
{
"name": "Items"
},
{
"name": "ItemTree"
},
{
"name": "ItemTypes"
},
{
"name": "ItemWarehouseHistories"
},
{
"name": "ItemWarehouses"
},
{
"name": "JobGroups"
},
{
"name": "JobHistories"
},
{
"name": "JobHistoryDataEntries"
},
{
"name": "JobHistoryDataEntryDocuments"
},
{
"name": "JobListWebSearch"
},
{
"name": "JobMailTemplates"
},
{
"name": "JobRecommendations"
},
{
"name": "JobRequestMailTemplates"
},
{
"name": "JobRequests"
},
{
"name": "JobRequestTemplateLogos"
},
{
"name": "JobRequestTemplates"
},
{
"name": "JobResponsibles"
},
{
"name": "Jobs"
},
{
"name": "JobSequences"
},
{
"name": "JobTemplates"
},
{
"name": "License"
},
{
"name": "LiquidTypes"
},
{
"name": "LocalizationLanguages"
},
{
"name": "LocalizationTexts"
},
{
"name": "Log"
},
{
"name": "LogbookDocuments"
},
{
"name": "LogbookEvents"
},
{
"name": "LubeOilTypes"
},
{
"name": "MailAccounts"
},
{
"name": "ManagementSystemApprovedPlanDocuments"
},
{
"name": "ManagementSystemBrowser"
},
{
"name": "ManagementSystemChangeRequests"
},
{
"name": "ManagementSystemDocumentAcknowledgements"
},
{
"name": "ManagementSystemDocumentDocuments"
},
{
"name": "ManagementSystemDocuments"
},
{
"name": "ManagementSystemPublish"
},
{
"name": "ManagementSystemROCs"
},
{
"name": "ManagementSystems"
},
{
"name": "ManagementSystemSections"
},
{
"name": "ManagementSystemTemplateDocuments"
},
{
"name": "MasterDataManagement"
},
{
"name": "MasterDataManagementTasks"
},
{
"name": "MasterDataManagementTreeStructure"
},
{
"name": "MasterDataManagementUnitTreeStructure"
},
{
"name": "MasterUnit"
},
{
"name": "MDMUnit"
},
{
"name": "MeasurementLocations"
},
{
"name": "Measurements"
},
{
"name": "MeasurementTypes"
},
{
"name": "MeasuringUnits"
},
{
"name": "OdsrbOperations"
},
{
"name": "OdsrbReceivers"
},
{
"name": "OperationTypeConfigurations"
},
{
"name": "Options"
},
{
"name": "OptionsDynamicReportTemplates"
},
{
"name": "OptionsGlobals"
},
{
"name": "OptionsOfficeDynamicReportTemplates"
},
{
"name": "OptionsOfficeLabelTemplates"
},
{
"name": "OptionsOffices"
},
{
"name": "OrbNoons"
},
{
"name": "OrbOperations"
},
{
"name": "PackingUnits"
},
{
"name": "PaymentConditions"
},
{
"name": "Ports"
},
{
"name": "PostingPeriods"
},
{
"name": "PostponementReasons"
},
{
"name": "Priorities"
},
{
"name": "Procedures"
},
{
"name": "Projects"
},
{
"name": "PurchaseGroups"
},
{
"name": "PurchaseOrderApprovals"
},
{
"name": "PurchaseOrderDeliveryCosts"
},
{
"name": "PurchaseOrderPositions"
},
{
"name": "PurchaseOrders"
},
{
"name": "PurchaseTypes"
},
{
"name": "Purifiers"
},
{
"name": "Receivers"
},
{
"name": "RejectReasons"
},
{
"name": "Reminders"
},
{
"name": "RequestForQuotes"
},
{
"name": "RequisitionPositions"
},
{
"name": "Requisitions"
},
{
"name": "Resources"
},
{
"name": "Roles"
},
{
"name": "ScheduledTasks"
},
{
"name": "ScreenLayouts"
},
{
"name": "Seals"
},
{
"name": "SealStorageLocations"
},
{
"name": "SealTypes"
},
{
"name": "Sections"
},
{
"name": "Shipments"
},
{
"name": "ShipmentWays"
},
{
"name": "Soundings"
},
{
"name": "SoundingStatuses"
},
{
"name": "SoundingTableDocuments"
},
{
"name": "SoundingTables"
},
{
"name": "StandardTexts"
},
{
"name": "SubSealPointComponentTypes"
},
{
"name": "SubSealPoints"
},
{
"name": "Substances"
},
{
"name": "SuggestedActions"
},
{
"name": "TankOperationConfigurations"
},
{
"name": "Tanks"
},
{
"name": "TechnicalAccounts"
},
{
"name": "TransactionQueue"
},
{
"name": "TreeStructure"
},
{
"name": "UnitCompanies"
},
{
"name": "UnitGroups"
},
{
"name": "Units"
},
{
"name": "UnitShipments"
},
{
"name": "UserGroups"
},
{
"name": "UserRights"
},
{
"name": "Users"
},
{
"name": "UserSettings"
},
{
"name": "ValueLists"
},
{
"name": "VAT"
},
{
"name": "VesselReportBrowser"
},
{
"name": "VesselReportFieldListTemplateRevisionCaches"
},
{
"name": "VesselReportFieldListTemplates"
},
{
"name": "VesselReports"
},
{
"name": "VesselReportScripts"
},
{
"name": "VesselReportSequenceInstances"
},
{
"name": "VesselReportSequences"
},
{
"name": "VesselReportSignature"
},
{
"name": "VesselReportTableRevisionCaches"
},
{
"name": "VesselReportTables"
},
{
"name": "VesselReportTypeFieldDefinitions"
},
{
"name": "VesselReportTypeGroups"
},
{
"name": "VesselReportTypeRevisionCaches"
},
{
"name": "VesselReportTypes"
},
{
"name": "VesselTypes"
},
{
"name": "VoyageReports"
},
{
"name": "VrsApiConfigurations"
},
{
"name": "VrsApiScripts"
},
{
"name": "Warehouses"
},
{
"name": "WebDashboardContent"
},
{
"name": "WebDashboardPageBackgrounds"
},
{
"name": "WebDashboardPages"
},
{
"name": "WebDashboards"
},
{
"name": "Webhooks"
},
{
"name": "WebTaskListConfigurations"
}
]
}